#gittydocs ✨

Simple, but ejectable modern docs for simple devs.

Write docs in Markdown. Push to GitHub. Get a beautiful docs site.

#Features

• LLMs-ready — Automatic llms.txt generation, so AI agents can explore your docs with efficient tokens
• Easy & Minimal — One .jsonc config file, a couple of .mdx, push to GitHub, deploy anywhere
• Partial-Text Search — Ctrl+K to search (w/ flexsearch)
• Table of Contents — Auto-generated with scroll spy showing current section
• Copy Page — Copy entire page as Markdown with one click
• Dark Mode — Built-in toggle`
• GitHub Integration — "Edit this page" links
• Fully Customizable — Built on Velite + Vike + Solid. Eject anytime and own your stack
• Static Export — Deploy to any host

#Quick Start

To get started, all you really need is a folder with .mdx and gittydocs.jsonc files. But for convenience, you can also use the CLI to scaffold.

1. Scaffold with the CLI:

npx gittydocs@latest new docs # Creates a "docs" folder
npx gittydocs@latest dev docs # Live preview & hot-reload

This creates this file structure:

📁 docs
├── 📁 [static]           # assets are stored here
│   └── logo.svg
├── gittydocs.jsonc       # config
├── index.mdx             # the home page
├── getting-started.mdx   # a page
└── theme.css             # custom styles

2. (Optional) Recommended: add a dev script in your repo:

// package.json
{
  "scripts": {
    "dev:docs": "gittydocs dev docs"
  }
}

3. Make it yours w/ the gittydocs.jsonc! (More in Configuration#Options)

{
  "$schema": "https://raw.githubusercontent.com/blankeos/gittydocs/main/gittydocs.schema.json",
  "site": {
+    "name": "MyDocs",
+    "description": "Documentation about my tools!",
+    "logo": "/static/logo.svg",
+    "socialBanner": "/static/banner.png",
    ...
}

4. Add some pages with about-us.mdx (More in Configuration#Writing-Content)

---
title: About Us
description: A little about the team
---

# Welcome

Your content here.

5. Push to GitHub. Pick a deployment option:

• GitHub Pages
• Vercel
• Cloudflare Pages
• Netlify

🎉 That's literally it! You have docs now!