docusaurus is a free, open source documentation & knowledge base project written in TypeScript and released under MIT. It has 66,471 GitHub stars, 10,071 forks and 430 open issues, and was last pushed 32 hours ago. On this registry it ranks #3 of 96 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available.

What is docusaurus?

Docusaurus is an open-source static site generator from Meta for maintainers who need a documentation, blog, and project website that is easy to keep up to date.

What it is

Docusaurus is a TypeScript-based project for building, deploying, and maintaining open source project websites. It lives in the React and JavaScript ecosystem and ships the key pages a project site needs out of the box — a home page, a docs section, a blog, and additional support pages — while still allowing those pages to be customized so the result looks like the project's own site rather than a template. It is MIT licensed, with its own documentation under Creative Commons.

The concrete problem it addresses is the maintenance burden of running a project website. Docusaurus is built to handle the website build process so that contributors can focus on their project instead of on site tooling, and it is built so that it can get running in as little time as possible. It also solves the localization problem that open source projects face when their communities grow internationally, shipping localization support via CrowdIn so that community members can translate the documentation. The project was released by Meta because it helps the organization better scale and supports the many OSS projects at Meta, and other organizations are invited to benefit from it.

What it is

Wait — I need to restructure: sections must be exactly those listed, in order.

Key capabilities

  • Creates a new site from scratch with the initialization CLI, npm init docusaurus@latest.
  • Ships a ready-made home page, docs section, blog, and support pages as the starting structure.
  • Provides localization support via CrowdIn, with an internationalization documentation section covering translation of the site.
  • Supports creating additional custom pages beyond the defaults.
  • Offers styling and layout customization so a site can be made uniquely a project's own.
  • Publishes a 5-minute tutorial at tutorial.docusaurus.io and a browser playground at docusaurus.new for immediate testing.
  • Maintains beginner-friendly issues labelled good first issue for new contributors, alongside a contributing guide at CONTRIBUTING.md.

Who uses it and how

  • Open source projects that need a documentation site, a blog, and support pages maintained alongside the codebase, which is the site type Docusaurus is explicitly built for.
  • Organizations such as Meta that need to run many OSS project websites and want the build process handled centrally by the tool.
  • International communities that translate their documentation through the Crowdin-based localization workflow.
  • New contributors working through the good first issue label and the contributing guide to propose bugfixes and improvements to the core.
  • Anyone evaluating the tool who wants to try it first in the playground at docusaurus.new or follow the 5-minute tutorial before committing.

Getting started

Run the initialization CLI with npm init docusaurus@latest to create your site, then consult the installation documentation; alternatively, test immediately in the browser playground at docusaurus.new or work through the 5-minute tutorial.

How it compares

Docusaurus stands alone in this registry: the facts provided name no other documentation site generator or comparable static publishing tool for it to be set against.

When to use it — and when not to

It suits teams that want a React- and TypeScript-based site with docs, a blog, and localization already structured for them, but the self-hoster should expect to operate the build pipeline and hosting for the generated site, and to wire up translation work through CrowdIn if localization is needed. It is a poor fit for those who need a server-rendered application rather than a generated project website, and note that the repository currently carries 430 open issues, which indicates a substantial backlog of unresolved reports for anyone relying on it in production.

project readme (upstream, from github) — read inline

Docusaurus

Docusaurus

Twitter Follow npm version GitHub Actions status PRs Welcome Discord Chat code style: prettier Tested with Jest Covered by Argos Gitpod Ready-to-Code Netlify Status Deploy with Vercel Deploy to Netlify

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.

Frequently asked questions

Is docusaurus free to use?

docusaurus is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does docusaurus do?

Easy to maintain open source documentation websites.

What is docusaurus written in?

docusaurus is primarily written in TypeScript. Its source is publicly available at https://github.com/facebook/docusaurus, and it has 66,471 GitHub stars.