Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

omniscriptosf.github.io

Official landing page for OmniScript - the universal document DSL for LLMs and AI.

🎨 Design System

Built with the NOIR design system - a terminal-aesthetic design language featuring:

  • Pure black & white color scheme with grayscale variations
  • Monospace-first typography (JetBrains Mono)
  • Geometric precision with 8px base unit
  • Terminal-inspired components
  • Maximum clarity and readability

πŸ›  Tech Stack

  • Framework: Next.js 15 (Static Site Generation)
  • Language: TypeScript 5.x (strict mode)
  • Styling: Tailwind CSS 3.4+
  • Fonts: JetBrains Mono, Inter
  • Package Manager: Bun
  • Deployment: GitHub Pages
  • Playground Exports: External API (omniscript-api)

πŸš€ Development

# Install dependencies
bun install
# Start development server
bun run dev
# Build for production
bun run build
# Preview production build
bun run start

Visit http://localhost:3000 to see the site.

πŸ“¦ Project Structure

omniscript-site/
β”œβ”€β”€ app/
β”‚ β”œβ”€β”€ layout.tsx # Root layout with fonts
β”‚ β”œβ”€β”€ page.tsx # Landing page
β”‚ └── globals.css # NOIR design system styles
β”œβ”€β”€ components/
β”‚ β”œβ”€β”€ Terminal.tsx # Terminal window component
β”‚ └── CodeBlock.tsx # Code display component
β”œβ”€β”€ public/
β”‚ └── .nojekyll # Disable Jekyll processing
└── .github/
 └── workflows/
 └── deploy.yml # GitHub Pages deployment

πŸ”Œ Playground Exports

Playground export buttons call a separate backend API service. Set the API base URL via NEXT_PUBLIC_OSF_API_BASE (see .env.production).

The backend code now lives in a separate private repo: OmniScriptOSF/omniscript-api.

🌐 Deployment

The site automatically deploys to GitHub Pages on every push to main branch.

Live URL: https://omniscriptosf.github.io/

πŸ“„ License

MIT License - Built with ❀️ by Alphin Tom

About

🌐 Official documentation site for OmniScript Format (OSF) β€” Interactive playground, API docs, guides & v1.0 features

Topics

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /