voila.devPlatform

Start a docs site

Clone the docs site template, edit one config file, write MDX and deploy to Cloudflare.

This site is the docs site template with its own config and content: TanStack Start, prerendered to static files, served by a Cloudflare Worker, on @voila.dev/docs and @voila.dev/ui-docs.

  1. Clone the template

    bunx degit voila-voila-dev/platform/domains/docs/templates/docs-site my-docs
cd my-docs

    The template is built and tested inside the platform monorepo: its README lists the three edits that take it out (the workspace:^ versions and the @voila.dev/source condition). Then bun install.

  2. Edit docs.config.ts

    The site’s name and address, where the docs are served, the frontmatter vocabulary, the icons a page may name, the chrome’s words and the brand.

  3. Write the pages

    One .mdx file per page under src/content/docs, listed once in src/content/docs/navigation.ts. bun run test fails on a dead link, a page the sidebar forgets, or one nothing links to.

  4. Deploy

    bun run build
bunx wrangler deploy

What this site adds

The package pages are not MDX files: src/docs/readme-pages.ts reads every packages/*/README.md at build time and compiles it as Markdown, through a remark plugin that drops its title and points its relative links to the right page. A new package gets its page as soon as it has a README and a place in the sidebar.

Next steps

@voila.dev/docsFramework-free building blocks of a documentation site: a navigation registry, a typo-tolerant search, reader contexts, a link graph check, an OpenAPI reference model and an MDX pipeline for Vite.@voila.dev/ui-docsThe React layer of a documentation site on @voila.dev/docs: frame, sidebar, outline, search palette, reader context, MDX components and API reference pages, on Tailwind CSS 4 and Base UI.