Docusaurus

We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the Docusaurus v2 website for more details.

Docusaurus v1 doc is available at v1.docusaurus.io and code is available on branch docusaurus-v1

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

Tip: use new.docusaurus.io to test Docusaurus immediately in CodeSandbox.

• 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 as well to ensure you have a site that is uniquely yours.

Use the initialization cli to create your site:

npx @docusaurus/init@latest init [name] [template]

Example:

npx @docusaurus/init@latest init my-website classic

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

Facebook 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.

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.

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.

We have a few channels for contact:

• Discord with two text channels:
  • #docusaurus-users for those using Docusaurus.
  • #docusaurus-dev for those wanting to contribute to the Docusaurus core.
• @docusaurus on Twitter
• GitHub Issues

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

Thank you to all our backers! 🙏 Become a backer

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

Docusaurus is MIT licensed.

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

BrowserStack supports us with free access for open source.

Rocket Validator helps us find HTML markup or accessibility issues.