a1810c99fc
This isn't needed and we don't need to keep up with it everytime we push a package. We only have to keep up with the versioning in the main package.json |
||
|---|---|---|
| admin | ||
| docs | ||
| docusaurus-init | ||
| examples | ||
| lib | ||
| website | ||
| .gitignore | ||
| .npmignore | ||
| circle.yml | ||
| crowdin.yaml | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
Docusaurus
Docusaurus is a project for easily building, deploying, and maintaining open source project websites. CI badges go here
- Simple to Start Docusaurus is built to be easy to get up and running 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 via CrowdIn. Empower and grow your international community by translating your documentation.
- Customizable Docusaurus ships with the key pages and sections you need to get started. A home page, a docs section, a blog, and additional support pages.
Installation
Docusaurus is available as docusaurus package on npm
The recommended way to use Docusaurs depends on your project. Here you can find short guides for the most common scenarios:
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
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 contain bugs which are fairly easy to fix. This is a great place to get started.
License
Docusaurus is MIT licensed.