Docusaurus helps you ship a polished documentation website without building a custom tech stack. Write Markdown or MDX files, configure your site once, and deploy anywhere — GitHub Pages, Netlify, Vercel, or your own server. Built on React, it supports interactive components, versioning, internationalization, and full-text search out of the box.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/facebook/docusaurus/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Scaffold a new Docusaurus site in under a minute with
create-docusaurus.Configuration
Learn how
docusaurus.config.js controls every aspect of your site.Guides
Explore docs, blogs, pages, Markdown features, search, i18n, and styling.
API Reference
Full reference for the CLI, plugins, themes, and lifecycle hooks.
Get started in minutes
Start the dev server
Navigate into your project and launch the local preview:Your site is now live at
http://localhost:3000 with hot reloading enabled.Write your content
Add
.md or .mdx files to the docs/ directory. Docusaurus automatically generates sidebar navigation and handles routing.Deploy
Build and deploy to any static hosting provider:See the deployment guide for GitHub Pages, Netlify, Vercel, and more.
Why Docusaurus?
MDX Support
Write interactive documentation with JSX and React components embedded directly in Markdown files.
Versioning
Keep multiple documentation versions in sync with your software releases.
Internationalization
Translate your site into multiple languages with built-in i18n support and Crowdin integration.
Plugin Ecosystem
Extend your site with official plugins for blogs, sitemaps, PWA, analytics, and more.
Theme Customization
Override any theme component via the swizzle system for complete visual control.
Search
Integrate Algolia DocSearch or local search for instant full-text search across all your docs.