Skip to content

Latest commit

Β 

History

30 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docora

Create beautiful docs with Markdown & React components.

docora

npm version npm downloads License

πŸš€ Quick Start

Local Development

Create a new documentation project in seconds:

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

# Or create with i18n template for multi-language docs
npx create-docora my-docs -t i18n

# Navigate to your project
cd my-docs

# Start development server
npm run dev

That's it! Your documentation site will be running at http://localhost:3000

Online Development

Start by deploying the Docora template and create your git repository directly from Vercel:

Deploy with Vercel

🎯 What it creates

The CLI scaffolds a complete documentation project with:

  • ✨ Beautiful Design β€” Clean, modern documentation theme built on Next.js 16, React 19 & Tailwind CSS 4
  • πŸ“± Responsive β€” Mobile-first responsive design
  • πŸŒ™ Dark Mode β€” Built-in dark/light mode with next-themes
  • 🌍 Internationalization β€” Native i18n with locale-prefixed routes, per-locale sidebars and bundled UI strings
  • πŸ” Search β€” Compile-time command palette (Cmd/Ctrl-K), no hosted index required
  • πŸ“ Markdown Enhanced β€” MDX with MDC syntax so components need no imports
  • 🎨 Customizable β€” Semantic CSS tokens, layout slots and custom MDX components
  • ⚑ Fast β€” App Router, Server Components and statically prerendered pages
  • πŸ”§ TypeScript β€” Published as source, with full TypeScript support
  • πŸ€– AI Assistant β€” Drop-in chat that answers from your docs, cites sources, and generates code
  • πŸ”Œ Native MCP Server β€” Built-in Model Context Protocol server for AI tool integration (Cursor, VS Code, Claude, etc.)
  • πŸ“š Agent Skills Discovery β€” Publish skills from your docs site via /.well-known/skills/
  • πŸ“„ LLM-Ready β€” Automatic llms.txt, llms-full.txt and raw Markdown routes
  • πŸ—ΊοΈ SEO Optimized β€” Sitemap, robots.txt, canonicals and OG image generation out of the box

Learn more in the Docora documentation.

πŸ€– AI features

Docora ships with a full AI stack to help both your users and contributors:

Assistant

Embed an AI-powered chat in your docs that answers questions, cites sources, and generates code examples. Powered by Vercel AI Gateway β€” the UI is hidden until a credential is present. Set AI_GATEWAY_API_KEY locally, or rely on Vercel OIDC in production.

MCP Server

Every Docora site exposes an MCP server at /mcp with list-pages and get-page. Add it to Cursor, VS Code, Claude or any MCP client:

https://your-docs-domain.com/mcp

Agent Skills

Drop skills into a skills/ directory and Docora serves them at /.well-known/skills/ following the Agent Skills Discovery RFC. Users install them with a single command:

npx skills add https://your-docs-domain.com

πŸ“ Project Structure

Generated project

my-docs/
β”œβ”€β”€ content/              # Your markdown content
β”‚   β”œβ”€β”€ index.mdx        # Homepage
β”‚   └── docs/            # Documentation pages
β”œβ”€β”€ app/                 # Next.js App Router
β”œβ”€β”€ public/              # Static assets
β”œβ”€β”€ lib/source.ts        # Content source
β”œβ”€β”€ docs.config.ts       # Site configuration
β”œβ”€β”€ next.config.ts       # Next.js configuration
└── package.json         # Dependencies and scripts

Optional files and folders

Docora is a theme on top of the App Router, so you can use any feature of a classical Next.js project:

my-docs/
β”œβ”€β”€ docs.config.ts       # Site name, header, socials, footer, SEO
β”œβ”€β”€ next.config.ts       # Next.js configuration (wrap with withDocora)
β”œβ”€β”€ app/                 # App Router
β”‚   β”œβ”€β”€ components/      # Components (add your own)
β”‚   β”œβ”€β”€ about/page.tsx   # Extra pages (alongside the catch-all)
β”‚   └── api/             # API routes
β”œβ”€β”€ middleware.ts        # Route middleware
└── public/              # Static assets

/content folder structure

Single language structure:

content/
β”œβ”€β”€ index.mdx
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ index.mdx
β”‚   └── 1.getting-started/
β”‚       β”œβ”€β”€ .navigation.yml
β”‚       β”œβ”€β”€ 1.introduction.mdx
β”‚       └── 2.installation.mdx
└── guide/
    └── configuration.mdx

A numeric prefix sets sidebar order and is stripped from the URL. 1.introduction.mdx is served at /docs/getting-started/introduction.

Multi-language structure (with i18n):

content/
β”œβ”€β”€ en/
β”‚   β”œβ”€β”€ index.mdx
β”‚   └── docs/
β”‚       └── 1.getting-started/
β”‚           └── 1.introduction.mdx
└── fr/
    β”œβ”€β”€ index.mdx
    └── docs/
        └── 1.getting-started/
            └── 1.introduction.mdx

Scaffold this layout with:

npx create-docora my-docs -t i18n

⚑ Built with

Your project comes pre-configured with the best of the Next.js ecosystem:

  • Next.js 16 β€” App Router and Server Components
  • React 19 β€” UI, layouts and MDC blocks
  • Tailwind CSS 4 β€” Design tokens you can recolour
  • MDX β€” Markdown with components
  • MDC β€” Named components with no imports
  • Shiki β€” Syntax highlighting
  • next-themes β€” Dark mode
  • Vercel AI SDK β€” AI assistant (optional)

πŸ“– Documentation

For detailed documentation on customizing your Docora project, visit the GitHub repository.

πŸ› οΈ Development

This repository is a monorepo containing the theme, the CLI and the documentation site.

Local Development

# Clone this repository
git clone https://github.com/StaticMania/docora

# Install dependencies
pnpm install

# Run the documentation site
pnpm run dev

Package Structure

This is a monorepo containing:

🀝 Contributing

We welcome contributions. Please read CONTRIBUTING.md and the Code of Conduct before opening a pull request.

πŸ“„ License

Published under the MIT license.

About

Resources

Code of conduct

Contributing

Security policy

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages