Typst CLI Docs

A lightweight, static documentation site for the Typst command-line tooling.

Overview

Typst CLI Docs packages the most important command references, flags, and workflows for the Typst CLI into a single-page site. The site is generated with Next.js and renders Markdown content from content/cli-reference.md, making it easy to keep the documentation versioned and reviewable.

Features

• Single-source content: Edit one Markdown file and instantly refresh the site.
• Responsive layout: Tailwind-powered design tuned for laptops, tablets, and phones.
• Static export ready: Build once, ship anywhere; great for GitHub Pages, Vercel, or any static host.
• Markdown rendering: Uses react-markdown with customised typography for Typst command examples.

Prerequisites

• Node.js 20+ (Bun, pnpm, or npm all work)
• Optional: Bun ≥ 1.1 for faster local development

Install dependencies:

bun install
# or
pnpm install
# or
npm install

Local Development

bun run dev
# or pnpm dev / npm run dev

Then visit http://localhost:3000. Any edits to content/cli-reference.md hot-reload automatically.

Content Authoring

• Main reference lives in content/cli-reference.md.
• The homepage layout is defined in app/page.tsx and wraps the Markdown content with custom components.
• Global styling lives in app/globals.css. Modify Tailwind tokens or add custom classes there.

Tip: keep long examples fenced in code blocks to preserve formatting in the rendered page.

Build & Deployment

Create an optimized production build:

bun run build

To produce a static export (for GitHub Pages or simple hosting):

bun run build
bunx next export

The generated HTML lives in out/. Serve that directory with any static web server or deploy it to your preferred hosting provider.

Contributing

1. Fork or clone the repository.
2. Create a branch for your changes.
3. Run bun run lint (or npm run lint) before opening a pull request.
4. Describe which CLI version or feature your update targets so others can follow along.

Acknowledgements

• Typst for the typesetting system and CLI.
• Next.js, React, and Tailwind CSS for the web stack.

---

This project is community-maintained and not an official Typst project.