Quick Start Guide

Get up and running with Docunaut in minutes.

1. Installation

First, install the dependencies:

bash
npm install

2. Start Development Server

Run the development server:

bash
npm run dev

Visit http://localhost:3000 to see your documentation site.

3. Add Your Content

Edit config/pages-content.tsx to add your documentation pages:

typescript
export const pagesContent: Record<string, string> = {
  "my-page": `## My Page Title
  
Your markdown content here.
`,
}

4. Configure Navigation

Update config/site.ts to add your pages to the navigation:

typescript
{
  title: "Example Category",
  icon: "lucide:compass", //Any icon from iconify.design
  items: [
    { title: "Example Title", href: "/docs/guides/example-slug", icon: "lucide:settings" }, //Any icon from iconify.design
  ],
},

5. Customize

Customize the site settings, themes, and branding in config/site.ts.

That's it! You're ready to build your documentation site.