Sign inCreate account
Sign inCreate account

docusaurus

From public sources

Docusaurus is an open-source CLI and React-based framework for building, deploying and maintaining documentation websites for software projects.

CLI toolCategory: Developer Tools · Documentation toolsOpen sourcedata checked Oct 15, 2026
Add to compareAdd to collection

Overview

Maintaining a documentation website alongside a software project usually means wiring up static site generators, navigation, search and localization by hand. Docusaurus is an open-source project for building, deploying and maintaining project websites with much less setup. It is started with a single initialization command, npm init docusaurus@latest, which creates a site with a home page, a docs section and an optional blog. Pages can be customized through React components and styling, and the site ships with localization support through CrowdIn so documentation can be translated for international communities. Docusaurus is aimed at open-source maintainers and teams that want their documentation to live in the same repository as their code. It is released under the MIT license.
  • documentation
  • hacktoberfest
  • javascript
  • knowledge-base
  • open-source
  • react
  • website

Installation

Commands are shown, never run by the marketplace. Check them against the official documentation.

Compatibility

Unknown means no evidence was found — not that the product is incompatible.
PlatformStatusArchitectureEvidenceConfidence
WindowsUnknown———
macOSUnknown———
LinuxUnknown———
Container (OCI)Unknown———
Web browserCompatible—Declared on the card—

Releases

checked Oct 29, 2026
v3.10.2LatestJul 10, 2026Official source ↗

Files in 3.10.2

This release has no attached files.

Release history

Quality profile

algorithm quality-v1.0 · assessed Oct 15, 2026
Quality Score100
Risk Score0
Confidence 1.00
Quality Score and Risk Score are different measures. A high score does not guarantee safety.

Score components

Maintenance · 2020
last activity 0 days ago
Documentation · 1515
README 7456 chars, description present
Ready to use · 1515
install instructions: yes; releases: yes
Metadata · 1010
4/4 of description, homepage, license, topics
Releases · 1010
10 release(s), latest 97 days ago
Category confidence · 1010
classifier confidence 1
Adoption · 1010
66494 stars (log-dampened, 10k = max)
License clarity · 55
SPDX MIT
Community · 55
issues enabled, 10084 forks

License

MIT
Known licensefrom the repository host

This is the catalog policy status, not legal advice.

Sources

github.com/facebook/docusaurusPrimary★ 66,494 starslast activity Oct 15, 2026Primary repository · Confidence 1.00

Reviews

Sign in to write a review

No reviews yet.

Alternatives

storybookSimilar
Storybook is an open-source CLI-driven UI development tool for building, documenting, and testing frontend components in isolation across React, Vue, Angular, and more.MIT · Developer Tools
mkdocs-materialSimilar
Material for MkDocs is an open-source theme and framework for MkDocs that turns Markdown files into a searchable, responsive static documentation site.MIT · Developer Tools
npkillSimilar
List any node_modules 📦 dir in your system and how heavy they are. You can then select which ones you want to erase to free up space 🧹MIT · Developer Tools
reactivesearchSimilar
Search UI components for React and VueApache-2.0 · Developer Tools
it-toolsSimilar
Collection of handy online tools for developers, with great UX.GPL-3.0 · Developer Tools
docsifySimilar
Docsify is an open-source CLI documentation site generator that turns Markdown files into a website with no build step, for Developer Tools projects.MIT · Developer Tools

README

From facebook/docusaurus · license MIT · fetched Oct 29, 2026

Introduction

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Short on time? Check out our 5-minute tutorial ⏱️!

Tip: use docusaurus.new to test Docusaurus immediately in a playground.

  • Simple to Start

Docusaurus is built in a way so that it can get running in as little time as possible. We've built Docusaurus to handle the website build process so you can focus on your project.

  • Localizable

Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.

  • Customizable

While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable to ensure you have a site that is uniquely yours.

Installation

Use the initialization CLI to create your site:

npm init docusaurus@latest

Read the docs for any further information.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Meta has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner-friendly bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner-friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.

Contact

We have a few channels for contact:

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 Become a backer

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.

Special thanks

BrowserStack supports us with free access for open source.

[Rocket Validator logo]

Rocket Validator helps us find HTML markup and accessibility issues.

Open the repository ↗