A Next.js-based framework for building documentation and content sites from MDX and Markdown files.
13.9K1.4KTypeScriptMITUpdated 3 months ago
meta/docusaurus
A React-based static site generator for building, deploying and maintaining open source project documentation websites.
- Stars
- 66,662
- Forks
- 10,120
- Open issues
- 422
- Last commit
- 18 hours ago
What is it?
Docusaurus is a tool for building, deploying and maintaining documentation and project websites. It is built on React and is aimed at open source projects that need a docs section, a blog and supporting pages without assembling the site from scratch.
Sites are created with a初始化 CLI through npm, and the framework handles the build process so that maintainers can focus on content. It ships with a docs section, a blog, and additional support pages, and the layout and styling can be customized.
The project supports localization through CrowdIn, which lets documentation be translated for international communities. It is MIT licensed and developed by Meta.
Key features
- 01Creates a documentation site with a single npm init command.
- 02Includes a docs section, a blog and support pages out of the box.
- 03Supports localization through CrowdIn.
- 04Pages and styling can be customized with React.
Use cases
- Publishing documentation for an open source library or framework.
- Building a project website that combines docs, a blog and landing pages.
- Translating project documentation for an international community.
Quick start
- 1
Run the initialization CLI to create your site
npm init docusaurus@latest - 2
Read the installation docs for further steps
In collections
Topics
FAQ
- What is docusaurus?
- A React-based static site generator for building, deploying and maintaining open source project documentation websites. Docusaurus is a tool for building, deploying and maintaining documentation and project websites. It is built on React and is aimed at open source projects that need a docs section, a blog and supporting pages without assembling the site from scratch.
- Is docusaurus free to use? What license does it have?
- docusaurus is open source under the MIT license. Check the license terms before using it in commercial products.
- Is docusaurus still maintained?
- Actively maintained. The last commit to docusaurus was on Nov 6, 2026.
- What can I use docusaurus for?
- Publishing documentation for an open source library or framework. Building a project website that combines docs, a blog and landing pages. Translating project documentation for an international community.
- How do I install docusaurus?
- Run the initialization CLI to create your site: npm init docusaurus@latest Read the installation docs for further steps
- Where can I get docusaurus?
- The source code and installation instructions are on GitHub: https://github.com/meta/docusaurus
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A fast, flexible static site generator written in Go, for building websites from Markdown content and templates.
90.4K+108 this week8.4KGoApache-2.0Updated 18 hours ago
Open-source, web-based localization platform for managing app translations with in-context editing, SDKs, and machine translation.
4.2K+9 this week380TypeScriptOtherWell maintainedUpdated 22 hours ago
A Claude agent skill that builds interactive isometric SVG illustrations of real machines and systems to explain technical ideas.
25.5K+2.5K this week2.1KJavaScriptMITUpdated 20 days ago
A Vue- and Vite-powered static site generator for building documentation and content sites from Markdown.
18.5K+23 this week2.8KTypeScriptMITWell maintainedUpdated 2 days ago
A React framework for building full-stack web applications, with Rust-based tooling for fast builds.
143.4K+154 this week33.5KJavaScriptMITUpdated 18 hours ago