Introduction
Welcome to Docstra, a modern documentation framework built for Next.js.
What is Docstra?
Docstra is a powerful, yet simple documentation framework designed to help you create beautiful, high-performance documentation sites with ease. Built on top of Next.js, it leverages the latest web technologies to provide a seamless development and user experience.
Docstra is currently in beta. We are actively working on adding more features and improving the framework.
Why Docstra?
- 🚀 Blazing Fast: Built on Next.js, Docstra ensures your documentation is fast and SEO-friendly.
- 📝 MDX Powered: Write your content in Markdown or use MDX to embed React components directly into your docs.
- 🔍 Built-in Search: Full-text search capability out of the box, powered by Fuse.js.
- 🎨 Tailwind CSS Integration: Styled with Tailwind CSS for easy customization and modern aesthetics.
- 📱 Fully Responsive: Your docs will look great on any device, from desktop to mobile.
- 💬 Feedback System: Gather user feedback easily with built-in FormSync integration.
- 🐙 GitHub Integration: "Edit on GitHub" links make it easy for your community to contribute.
Quick Start
If you're ready to dive in, you can create a new Docstra project in seconds:
bash1npx create-docstra-app@latest
Check out our Quick Start Guide for more details.
Core Concepts
Docstra follows a few simple concepts to make documentation management a breeze:
- Content-First: Your documentation lives in a dedicated
contentdirectory as MDX files. - File-Based Routing: The folder structure in your
contentdirectory defines the navigation and URLs of your documentation. - Configurable: A single
docstra.config.tsfile allows you to customize almost every aspect of your site.
| Feature | Description | Status |
|---|---|---|
| MDX | Full MDX support with syntax highlighting | ✅ Stable |
| Search | Built-in search functionality | ✅ Stable |
| Layouts | Customizable layouts and navigation | ✅ Stable |
| Components | Set of beautiful documentation components | 🏗️ Improving |
| i18n | Multi-language support | ⏳ Planned |
Currently, Docstra exclusively supports Next.js. Support for other frameworks is on our roadmap.
How is this guide?