Popularity
9.9
Stable
Activity
9.8
Declining
43,109
367
6,666

Description

Docusaurus is Facebook's documentation static site generator, based on React, Node.js and Markdown, powering many docs sites such as React-Native, Jest, Redux, Babel, Prettier, Supabase, Ionic, Electron...

Programming language: TypeScript
License: MIT License
Tags: Dev Tools     React     Javascript    
Latest version: v2.2.0

Docusaurus alternatives and similar libraries

Based on the "Dev Tools" category.
Alternatively, view Docusaurus alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of Docusaurus or a related project?

Add another 'Dev Tools' Library
Access the most powerful time series database as a service
sponsored www.influxdata.com

Popular Comparisons

Write Clean JavaScript Code. Always.
sponsored www.sonarsource.com

README

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

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

Installation

Use the initialization CLI to create your site:

npm init [email protected]

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 Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

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.

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](CONTRIBUTING.md)].

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](./LICENSE).

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

Special thanks

[BrowserStack logo](./admin/img/browserstack-logo.png)

BrowserStack supports us with free access for open source.

[Rocket Validator logo](./admin/img/rocketvalidator-logo.png)

Rocket Validator helps us find HTML markup or accessibility issues.


*Note that all licence references and agreements mentioned in the Docusaurus README section above are relevant to that project's source code only.