Github url

docusaurus

by facebook

facebook /docusaurus

Easy to maintain open source documentation websites.

17.9K Stars 2.0K Forks Last release: 23 days ago (v2.0.0-alpha.58) Other 2.7K Commits 100 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Docusaurus

Docusaurus

npm versionCircleCI statusPRs WelcomeChatcode style: prettierTested with JestGitpod Ready-to-CodeNetlify Status

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.

You can see the clean live demo with classic theme by clicking this badge Runme.

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 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 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

Docusaurus is available as the [

docusaurus

package](https://www.npmjs.com/package/docusaurus) on npm.

We have also released the [

docusaurus-init

package](https://www.npmjs.com/package/docusaurus-init) to make getting started with Docusaurus even easier.

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:

  • Discord with two text channels:

    #docusaurus-users

    for those using Docusaurus.

    #docusaurus-dev
    for those wanting to contribute to the Docusaurus core.
  • @docusaurus on Twitter
  • GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

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.

The Docusaurus documentation (e.g.,

.md

files in the

/docs

folder) is Creative Commons licensed.

Special thanks

BrowserStack logo

BrowserStack supports us with free access for open source.

Rocket Validator logo

Rocket Validator helps us find HTML markup or accessibility issues.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.