#gittydocs ✨

Simple, but ejectable modern docs for simple devs.

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

#Quick Start

Scaffold with the CLI:

npx gittydocs@latest new docs
cd docs
npx gittydocs@latest dev docs

Recommended: add a dev script in your repo:

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

Or if you use a Justfile:

# justfile
devdocs:
	gittydocs dev docs

Or do it manually.

Create a docs folder in your repo:

mkdir -p docs

Add gittydocs.jsonc:

// docs/gittydocs.jsonc
{
  "site": {
    "name": "My Project",
    "repo": {
      "owner": "yourusername",
      "name": "yourrepo",
      "ref": "main",
      "docsPath": "docs",
    },
  },
}

Add a page (i.e. docs/index.mdx):

---
title: Welcome
---

# Welcome

Your content here.

Push to GitHub. Pick a deployment option:

• Deployment Overview
• GitHub Pages
• Vercel
• Cloudflare Pages
• Netlify

#Features

• Quick & Easy — One config file, push to GitHub, deploy anywhere
• Full-Text Search — Ctrl+K for instant search across all docs
• 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