A free, open-source Mintlify-style documentation system built with Next.js and Fumadocs.
npx create-unmint@latest my-docs
| Site | Description |
|---|---|
| specstory.com | AI chat context management |
| intent.build | System of record for software decisions |
Open a PR to add your site
- Beautiful out-of-the-box — Professional styling without configuration
- MDX Components — Cards, callouts, tabs, steps, accordions, and more
- Built-in Search — Full-text search powered by Fumadocs
- Dynamic OG Images — Auto-generated social preview images
- Dark Mode — Seamless light/dark theme switching
- Easy Theming — Single config file for all customization
- SEO Optimized — Automatic meta tags and sitemap
Note: Unmint is self-hosted, not a SaaS. You own everything and deploy it yourself.
npx create-unmint@latest my-docs
This will prompt you for project configuration and set up everything automatically.
# Create with all defaults (no prompts) npx create-unmint@latest my-docs --yes # Update an existing project to latest cd my-docs npx create-unmint@latest --update
Already have a Next.js site? Add Unmint docs alongside your existing app:
# Navigate to your existing project cd my-existing-site # Add docs at /docs route npx create-unmint@latest --add # Or specify a custom route npx create-unmint@latest --add --path /documentation
This will:
- Detect your project structure (src/app or app)
- Copy docs components and sample content
- Merge dependencies into your package.json
- Add scoped CSS variables (won't conflict with your existing styles)
- Wrap your next.config with MDX support
Your existing site remains untouched - docs are added as a new route.
You can also clone the template directly:
# Clone just the template git clone https://github.com/gregce/unmint.git cp -r unmint/packages/template my-docs cd my-docs # Install dependencies npm install # Start development server npm run dev
Open http://localhost:3000 to see your docs.
This is a monorepo containing:
unmint/
├── packages/
│ ├── create-unmint/ # CLI tool (npx create-unmint)
│ └── template/ # The documentation template
├── package.json
└── README.md
my-docs/
├── app/
│ ├── docs/ # Documentation routes
│ │ ├── layout.tsx # Docs layout (header, sidebar, footer)
│ │ └── [[...slug]]/ # Dynamic page rendering
│ ├── api/
│ │ ├── search/ # Search API endpoint
│ │ └── og/ # OG image generation
│ └── components/
│ └── docs/ # Docs-specific components
│ └── mdx/ # MDX components (Card, Callout, etc.)
├── content/
│ └── docs/ # Your MDX documentation files
│ ├── index.mdx # Homepage
│ ├── meta.json # Navigation structure
│ └── *.mdx # Your pages
├── lib/
│ ├── theme-config.ts # ⭐ Customize your theme here
│ ├── docs-source.ts # Fumadocs source config
│ └── utils.ts # Utility functions
├── public/ # Static assets (logo, images)
├── source.config.ts # MDX/Fumadocs configuration
└── package.json
Edit lib/theme-config.ts:
export const siteConfig = { name: 'My Docs', description: 'Documentation for My Project', url: 'https://docs.example.com', logo: { src: '/logo.png', alt: 'My Project', width: 32, height: 32, }, links: { github: 'https://github.com/your-org/your-repo', discord: 'https://discord.gg/your-invite', support: 'mailto:[email protected]', }, }
export const themeConfig = { colors: { light: { accent: '#0891b2', // Your brand color }, dark: { accent: '#22d3ee', // Brighter for dark mode }, }, }
Place your logo in public/logo.png and update siteConfig.logo.src.
Create MDX files in content/docs/:
--- title: My Page description: A description of my page --- # Hello World This is my documentation page! <Tip> You can use all the built-in components. </Tip>
Edit content/docs/meta.json:
{
"title": "Documentation",
"pages": [
"index",
"quickstart",
"---Getting Started---",
"installation",
"configuration",
"---Guides---",
"deployment"
]
}<CardGroup cols={2}> <Card title="Quick Start" icon="rocket" href="/docs/quickstart"> Get started in 5 minutes </Card> <Card title="API Reference" icon="code" href="/docs/api"> Explore our API </Card> </CardGroup>
<Info>Informational message</Info> <Tip>Helpful tip</Tip> <Warning>Warning message</Warning> <Note>Additional note</Note> <Check>Success message</Check>
<Steps> <Step title="Install"> Run `npm install` </Step> <Step title="Configure"> Edit your config file </Step> </Steps>
<Tabs> <Tab title="npm">npm install package</Tab> <Tab title="yarn">yarn add package</Tab> </Tabs>
<AccordionGroup> <Accordion title="Question 1">Answer 1</Accordion> <Accordion title="Question 2">Answer 2</Accordion> </AccordionGroup>
- Push to GitHub
- Import at vercel.com/new
- Deploy!
- Add
netlify.toml:[build] command = "npm run build" publish = ".next" [[plugins]] package = "@netlify/plugin-nextjs"
- Connect and deploy
Any platform supporting Next.js works. Run npm run build and deploy the output.
Contributions are welcome! Please feel free to submit a Pull Request.
MIT License - feel free to use this for any project.
Built with:
Inspired by Mintlify.