🌟 The Universal Document DSL

One format to generate documents, slides, sheets, charts, diagrams, and more

🚀 Quick Start • 📦 Packages • 🎯 Features • 📖 Documentation • 🧪 Playground

OmniScript Format v1.3.0 brings export parity, richer previews, and tighter UX alignment:

• ✨ @table export parity - Tables render across PDF/DOCX/PPTX/XLSX
• ✨ Blockquote styling - Consistent quotes in exports and preview
• ✨ Preview alignment - Playground/exports now render the same
• 🧪 Stability polish - Alignments and bug fixes across renderers

• 🛡️ Path traversal protection - Prevents directory escape attacks
• 🛡️ ReDoS prevention - Bounded regex quantifiers
• 🛡️ Strict input validation - All inputs validated at multiple layers
• 🛡️ Defense-in-depth - Multi-layer security architecture
• ✅ All P0-P2 security issues fixed

• ✅ 130/130 tests passing (was 56 - +132% increase)
• ✅ Zero breaking changes - Fully backward compatible
• ✅ Better error messages - Contextual debugging information
• ✅ Type-safe - Zero 'any' types, strict TypeScript mode

View Full Release Notes → | Security Review →

OmniScript Format (OSF) is a universal document description language that lets you write structured content once and export it to multiple formats:

@meta {
  title: "My Document";
  author: "John Doe";
}

@doc {
  # Hello World

  This is **OmniScript** - write once, export everywhere!
}

@table {
  caption: "Sales Report";
  style: "bordered";
  alignment: ["left", "right", "center"];

  | Product | Revenue | Status |
  | --- | --- | --- |
  | Widget A | $100K | ✓ Growth |
  | Widget B | $85K | → Stable |
}

@chart {
  type: "bar";
  title: "Sales Data";
  data: [
    { label: "Q1"; values: [100]; },
    { label: "Q2"; values: [150]; }
  ];
}

@include { path: "./sections/summary.osf"; }

@slide {
  title: "Presentation Slide";
  layout: TitleAndContent;

  - Point 1
  - Point 2
}

@sheet {
  name: "Data";
  cols: [Name, Value];

  A1 = "Product"; B1 = "Price";
  A2 = "Widget";  B2 = 99;
}

Export to: PDF 📄 • DOCX 📝 • PPTX 🎞️ • XLSX 📊

npm install -g omniscript-cli

# Create a new OSF file
cat > hello.osf << 'EOF'
@meta {
  title: "My First Document";
}

@doc {
  # Hello, OmniScript!

  Welcome to the **universal document format**.
}
EOF

# Parse and validate
osf parse hello.osf

# Export to PDF
osf export hello.osf --format pdf --output hello.pdf

npm install omniscript-parser omniscript-converters

import { parse } from 'omniscript-parser';
import { PDFConverter } from 'omniscript-converters';

const osf = `
@doc {
  # My Document
  Content here...
}
`;

const doc = parse(osf);
const converter = new PDFConverter();
const result = await converter.convert(doc);

// result.buffer contains the PDF

Editor support is on the roadmap (syntax highlighting, IntelliSense, diagnostics).

Zero-dependency TypeScript parser for OSF.

npm install omniscript-parser

Features: Parse OSF → AST • @table & @include support • Security grade A+ • 83 tests passing

View README →

Enterprise-grade document converters.

npm install omniscript-converters

Features: PDF with charts • DOCX with tables • PPTX with native charts • XLSX with formulas

View README →

Professional command-line interface.

npm install -g omniscript-cli

Commands: parse • lint • render • export • format • diff • Table & include support

View README →

• PDF - High-quality documents with charts and diagrams
• DOCX - Microsoft Word with tables and formatting
• PPTX - PowerPoint with native charts
• XLSX - Excel with formulas and data

10+ professional themes: corporate • modern • academic • minimal • colorful • dark • blueprint • ocean • forest • sunset

• Installation - Install OSF tools
• First Document - Create your first OSF file
• Examples - 16+ professional examples

• v1.2 Specification - Current OSF spec
• v1.0 Specification - Complete OSF v1.0 spec
• v0.5 Specification - Legacy spec
• Roadmap - Future features

• Architecture - System architecture
• Contributing - Contribution guidelines
• Development Guide - Development process
• Testing - Test results and coverage

• Release Notes - v1.0 release details
• Code Quality - Code review and fixes
• Security - Security measures

Interactive Playground: https://omniscript.dev/playground

• ✍️ Write OSF in Monaco editor
• 👁️ Live preview
• 📥 Export to PDF, DOCX, PPTX, XLSX
• 🎨 Test different themes

Write technical documentation once, export to PDF for distribution and DOCX for editing.

Create classroom materials with sheets for exercises and slides for presentations.

Generate reports with charts and data tables, export to PDF for sharing.

Create dashboards with charts and diagrams, export to multiple formats.

Build professional presentations with charts, code samples, and diagrams.

git clone https://github.com/OmniScriptOSF/omniscript-core.git
cd omniscript-core
bun install
bun run build

# Run all tests
bun test --recursive

# Test individual packages
cd omniscript-core/parser && bun test
cd omniscript-converters && bun test
cd omniscript-core/cli && bun test

# Build all packages
bun run build --recursive

# Build individual packages
cd omniscript-core/parser && bun run build

We welcome contributions! See CONTRIBUTING.md for guidelines.

• 🐛 Report bugs via GitHub Issues
• 💡 Suggest features
• 📝 Improve documentation
• 🔧 Submit pull requests
• 🎨 Create themes
• 📚 Add examples

MIT License - see LICENSE for details.

• Website: https://omniscript.dev
• GitHub: https://github.com/OmniScriptOSF
• npm: https://www.npmjs.com/search?q=omniscript
• Editor Support (Roadmap): https://github.com/OmniScriptOSF/omniscript-core/blob/main/spec/roadmap.md

• Documentation: https://omniscript.dev/docs
• GitHub Issues: https://github.com/OmniScriptOSF/omniscript-core/issues
• GitHub Discussions: https://github.com/OmniScriptOSF/omniscript-core/discussions

Built with ❤️ using:

• TypeScript - Type-safe language
• Puppeteer - PDF generation
• PptxGenJS - PowerPoint generation
• docx - Word generation
• ExcelJS - Excel generation
• Mermaid - Diagram rendering
• Chart.js - Chart rendering