Skip to content

OmniScriptOSF/omniscriptosf.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

53 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

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

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors