gittydocsgittydocs

v0.0.5

Zero-config docs. MDX and JSON—no app code.

Drop .mdx pages and a gittydocs.jsonc in a folder. Get search, themes, /llms.txt, and static deploy. Use the CLI to scaffold—skip JavaScript until you want to customize or eject.

Read the docsGitHub

Write. Push. Ship.

Content and config only—no doc app to build unless you choose to.

  • MDX + JSON

    Pages in .mdx, site settings in gittydocs.jsonc—no React app to author.

  • Push to GitHub

    Your repo is the source of truth. “Edit this page” links back to it.

  • Deploy static

    GitHub Pages, Vercel, Cloudflare, Netlify — same export everywhere.

Defaults, not a checklist

Search, ToC, dark mode, and agent exports—on without flipping feature flags.

  • AI-ready

    Build-time /llms.txt so agents can skim your docs without parsing HTML.

  • Search & ToC

    ⌘ K search and scroll-spy headings — no config switch to flip.

  • Ejectable

    Velite + Vike + Solid under the hood. Stay packaged or own the template.

Five minutes to a live preview

Introduction, CLI, and deploy guides—then theme it or eject the stack.

Open IntroductionCLI reference