Docusaurus
An optimized site generator in React. Docusaurus helps you to move fast and write content. Build documentation websites, blogs, marketing pages, and more.
About Docusaurus
Docusaurus is a static site generator built with React, designed for creating documentation and content-focused websites. Content is written in MDX, allowing Markdown documents to embed React components, and Docusaurus compiles these into optimized static HTML files. The project has a pluggable architecture that lets developers extend and customize site layouts with React components while reusing data from Docusaurus plugins.
The tool includes built-in support for localization, allowing documentation to be translated using git, Crowdin, or other translation managers and deployed per language. It also provides document versioning, enabling projects to maintain documentation in sync with multiple release versions, and integrates with Algolia for content search across documentation sites.
Docusaurus is aimed at developers and teams building documentation sites, project wikis, and open-source project websites. It is maintained by Meta Platforms, Inc., and is used by organizations including Redux, Supabase, and Temporal for their documentation.
Key features
- Write docs and blog posts in MDX with embedded React components
- Static site built with React for customizable, pluggable layouts
- Built-in localization/translation support via git, Crowdin, or other tools
- Document versioning to keep docs in sync with project releases
- Integrated content search via Algolia
Frequently asked questions
What is Docusaurus used for?
Docusaurus is a tool for building optimized documentation and content-focused websites, letting you focus on writing while it builds static HTML from your files.
What format do I write content in?
Content is written in MDX, which combines Markdown with the ability to embed React components.
Does Docusaurus support multiple languages?
Yes, localization is supported out-of-the-box using git, Crowdin, or any other translation manager, with translated docs deployable individually.
Can I manage multiple versions of my documentation?
Yes, document versioning is supported to help keep documentation in sync with different project releases.
Who uses Docusaurus?
It has been used by projects and companies including Redux, Supabase, React Native, ReasonML, and Temporal for their documentation sites.
Show your product to thousands of developers
· 100k monthly pageviews
· 7k newsletter subscribers
You might also like
DeepDocs
Documentation/AIAI that updates docs when you ship code.
DevDocs
DocumentationFast, offline, and free documentation browser for developers. Search 100+ docs in one web app including HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C, C++, and many more.
Gitbook
DocumentationGitBook is a knowledge management tool for engineering teams. It simplifies knowledge sharing, with docs-as-code support and AI-powered search & insights.
Heroshot
Screenshot/Documentation/ToolingScreenshot automation CLI for documentation. Define screenshots once in config, regenerate all with one command using Playwright.
MDN Web Docs
DocumentationThe MDN Web Docs site provides information about Open Web technologies including HTML, CSS, and APIs for both Web sites and progressive web apps. It also has some developer-oriented documentation for Mozilla products, such as Firefox Developer Tools.
Trails
Documentation/Productivity/AIThe easiest way to document your process.
