Welcome to Documentation
Modern documentation generator built with Next.js 16
2 min read
Welcome to Documentation
A modern, fast documentation generator built with Next.js 16. Fork this repo and create your own documentation site in minutes.
Features
- 📝 Markdown & MDX Support - Write your docs in Markdown or MDX with full frontmatter support
- 🎨 Beautiful UI - Clean, modern interface built with Tailwind CSS and shadcn/ui
- 🌓 Dark Mode - Built-in dark mode support with customizable themes
- 🔍 Full-Text Search - Find what you need quickly (coming soon)
- 📱 Mobile Responsive - Looks great on all devices
- ⚡ Fast Performance - Static generation for lightning-fast page loads
- 🔗 Relative Links - Use relative links between docs seamlessly
- 📑 Auto Navigation - Automatic sidebar and breadcrumb generation from file structure
Quick Start
Ready to create your own docs? It's incredibly simple:
- Fork the GitHub repository
- Clone your fork and install dependencies (
npm install) - Add your content to the
content/directory - Deploy to Vercel, Netlify, or any static hosting
That's it! Your documentation site will be live in minutes.
Learn More
Explore the documentation to customize your site:
- Getting Started - Complete setup guide and configuration
- Writing Docs - Best practices for writing documentation
- MDX Components - Available components and features
- API Reference - Complete API documentation