@baybreezy/docd

@baybreezy/docd

Build beautiful documentation sites with Nuxt, Markdown, and Vue components.

Quick Start

Scaffold a new project in seconds:

# Create a new docs project
npx create-docd my-docs

# Navigate to your project
cd my-docs

# Start the dev server
bun run dev

Your documentation site will be running at http://localhost:3000.

What you get

A fully configured documentation site with:

• Beautiful design — Clean, modern theme built on UI Thing components
• Theming — 17 color themes with light/dark mode out of the box
• Markdown enhanced — Extended MDC syntax with interactive components and prose wrappers
• Component API docs — Automatic prop/slot/event documentation from Vue component metadata
• Full-text search — Built-in search across all your content
• OG images — Automatic Open Graph image generation
• LLM-ready — Auto-generates llms.txt and llms-full.txt for AI tool integration
• MCP server — Built-in Model Context Protocol server for Cursor, VS Code, Claude, and more
• SEO — Sitemap, robots.txt, and meta tags configured automatically
• TypeScript — Full type safety throughout

Project structure

my-docs/
├── content/              # Your Markdown content
│   ├── index.md          # Homepage
│   └── docs/             # Documentation pages
├── public/               # Static assets
└── package.json

Docd is a Nuxt layer — you can extend it with any standard Nuxt feature:

my-docs/
├── nuxt.config.ts        # Extra modules and Nuxt configuration
├── app/
│   ├── app.config.ts     # Theme, navigation, and feature flags
│   ├── components/       # Your own Vue components (usable in Markdown)
│   ├── layouts/          # Custom layouts
│   └── pages/            # Extra pages outside of content/
└── server/               # Server-side code

Configuration

Most things are controlled through app.config.ts:

export default defineAppConfig({
  docd: {
    ui: {
      toc: { title: "On this page", icon: "lucide:list" },
      borderType: "dashed",
      transition: {
        name: "fade",
        duration: 0.35,
        easing: "easeOut",
      },
    },
  },
});

Full configuration reference: docd.uithing.com

Built with

• Nuxt — web framework
• Nuxt Content — file-based content layer
• UI Thing — component library
• Tailwind CSS — utility-first CSS
• Nuxt Image — optimised image handling
• nuxt-og-image — OG image generation
• nuxt-llms — LLM file generation

License

Published under the MIT license.