Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/facebook/docusaurus

Easy to maintain open source documentation websites.
https://github.com/facebook/docusaurus

documentation hacktoberfest javascript open-source react website

Last synced: 7 days ago
JSON representation

Easy to maintain open source documentation websites.

Awesome Lists containing this project

README 

        


  


    Docusaurus

    


    


    

      Docusaurus

    

  







  Twitter Follow

  

  

  npm version

  GitHub Actions status

  PRs Welcome

  Discord Chat

  code style: prettier

  

  Tested with Jest

  Covered by Argos

  Gitpod Ready-to-Code

  Netlify Status

  Deploy with Vercel

  Deploy to Netlify




## Introduction



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



Short on time? Check out our [5-minute tutorial ⏱️](https://tutorial.docusaurus.io)!



**Tip**: use **[docusaurus.new](https://docusaurus.new)** to test Docusaurus immediately in a playground.



- **Simple to Start**



> Docusaurus is built in a way so that it can [get running](https://docusaurus.io/docs/installation) 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](https://docusaurus.io/docs/i18n/introduction) 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/blog), and additional support pages, it is also [customizable](https://docusaurus.io/docs/creating-pages) as well to ensure you have a site that is [uniquely yours](https://docusaurus.io/docs/styling-layout).



## Installation



Use the initialization CLI to create your site:



```bash

npm init docusaurus@latest

```



[Read the docs](https://docusaurus.io/docs/installation) for any further information.



## Contributing



We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. 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)



Meta 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/main/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):

  - `#general` for those using Docusaurus.

  - `#contributors` for those wanting to contribute to the Docusaurus core.

- [@docusaurus](https://x.com/docusaurus) X

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



## Special thanks





  

    

      

      BrowserStack logo

    

  




[BrowserStack](http://www.browserstack.com/) supports us with [free access for open source](https://www.browserstack.com/open-source).



[![Rocket Validator logo](./admin/img/rocketvalidator-logo.png)](https://rocketvalidator.com/)



[Rocket Validator](https://rocketvalidator.com/) helps us find HTML markup or accessibility issues.