DocoraDocora

Getting Started

Installation

Get started with Docora.

Create Docora CLI

Create your docs directory

Use the create-docora CLI to scaffold a new Docora project. Node.js 20.9 or later is required.

Terminal
Terminal
npx create-docora my-docs

You can choose between two templates:

  • default: Basic Docora setup for single-language documentation
  • i18n: Includes internationalization support for multi-language documentation
Terminal
Terminal
# Create with i18n template
npx create-docora my-docs -t i18n

The CLI detects your package manager from the command you ran (npx, pnpm dlx, yarn dlx, or bunx) and installs dependencies for you. Pass --pm npm|pnpm|yarn|bun to choose one explicitly, or --no-install to skip the install.

Start your docs server in development

Move to your docs directory and start the development server:

Terminal
Terminal
cd my-docs
npm run dev

A local preview of your documentation will be available at http://localhost:3000.

Write your documentation

Every file under content/ becomes a route. Head over to Project Structure to learn how to write and organise your documentation.

AI Assistant Skill

Get started quickly with Docora by adding specialized knowledge to your AI assistant (Cursor, Claude, and others):

Terminal
Terminal
npx skills add https://docora.example.com

This skill helps you create documentation faster by providing your AI assistant with:

  • Best practices for writing documentation with Docora
  • MDC component usage and ready-to-use templates
  • Writing guidelines and content structure patterns
  • Configuration and customization tips

Once installed, your AI assistant can help you scaffold new documentation projects, generate pages with proper structure, and write content following Docora best practices.

You can also publish your own skills from your Docora site. Learn more about Agent Skills.

Theme Integration

Docora is a Next.js theme package. Add it to an existing App Router project on Next.js 16 and Tailwind CSS 4 by installing docora and wrapping your config with withDocora:

Terminal
Terminal
npm install docora
next.config.ts
next.config.ts
import { withDocora } from 'docora/next'
 
export default withDocora({})

withDocora transpiles the theme, which is published as TypeScript source. Import the stylesheet after Tailwind so the design tokens override the defaults:

app/globals.css
app/globals.css
@import 'tailwindcss';
@import 'docora/styles.css';

Then wrap the root layout with DocsRoot and pass a docs.config.ts:

docs.config.ts
docs.config.ts
import { defineDocsConfig } from 'docora'
 
export default defineDocsConfig({
  site: { name: 'Acme' },
})
app/layout.tsx
app/layout.tsx
import { DocsRoot } from 'docora'
import docsConfig from '../docs.config'
 
import './globals.css'
 
export default function RootLayout({ children }: { children: React.ReactNode }) {
  return <DocsRoot config={docsConfig}>{children}</DocsRoot>
}

The create-docora starter wires the catch-all route, search, sitemap and content source for you. See Configuration for every option the theme reads.