Docusaurus

## Introduction Docusaurus is a project for easily building, deploying, and maintaining open source project websites. - **Simple to Start** Docusaurus is built to be easy to [get up and running](https://docusaurus.io/docs/en/installation.html) in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project. - **Localizable** Docusaurus ships with [localization support](https://docusaurus.io/docs/en/translation.html) 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](https://docusaurus.io/docs/en/blog.html), and additional support pages, it is also [customizable](https://docusaurus.io/docs/en/custom-pages.html) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/en/api-pages.html). ## Installation Docusaurus is available as the [`docusaurus` package](https://www.npmjs.com/package/docusaurus) on [npm](https://www.npmjs.com). We have also released the [`docusaurus-init` package](https://www.npmjs.com/package/docusaurus-init) to make [getting started](https://docusaurus.io/docs/en/installation.html) with Docusaurus even easier. ## Contributing We've released Docusaurus because it helps us better scale and support 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](https://code.fb.com/codeofconduct) Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.fb.com/codeofconduct) so that you can understand what actions will and will not be tolerated. ### Contributing Guide Read our [contributing guide](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md) 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](https://github.com/facebook/docusaurus/labels/good%20first%20issue) that might contain smaller issues to tackle first. This is a great place to get started. ## Contact We have a few channels for contact: - [Discord](https://discord.gg/docusaurus) with two text channels: - `#docusaurus-users` for those using Docusaurus. - `#docusaurus-dev` for those wanting to contribute to the Docusaurus core. - [@docusaurus](https://twitter.com/docusaurus) on Twitter - [GitHub Issues](https://github.com/facebook/docusaurus/issues) ## Contributors This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/Docusaurus#backer)]

## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/Docusaurus#sponsor)]

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

	Stars	Issues	Version	Updated	Created
asciidoctor	712	61	3.0.4	3 months ago	5 years ago
docusaurus	53,218	322	1.14.7	3 years ago	7 years ago
gitbook	26,437	18	2.6.9	6 years ago	10 years ago
hugo	5	0	0.0.3	11 years ago	11 years ago
slate	29,073	640	0.103.0	a month ago	12 years ago
vuepress	22,371	614	1.9.10	9 months ago	6 years ago

asciidoctor vs docusaurus vs gitbook vs hugo vs slate vs vuepress

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past