Docusaurus

Docusaurus

npm version CircleCI Status PRs Welcome Chat code style: prettier Tested with Jest

## 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. ## 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).