Skip to content
Easy to maintain open source documentation websites.
Branch: master
Clone or download
Latest commit 41126fe Jul 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore(v2): rm flowtype (#1444) May 9, 2019
.github misc: add funding links May 26, 2019
admin chore: update prerelease.sh & prerelease.md (#886) Aug 3, 2018
docs docs: suggest ZEIT Now for quick deployment of 2.0 (#1691) Jul 22, 2019
packages v2.0.0-alpha.24 Jul 24, 2019
scripts chore: fix conflicting yarn 'version' Apr 10, 2019
website-1.x v2.0.0-alpha.24 Jul 24, 2019
website v2.0.0-alpha.24 Jul 24, 2019
.editorconfig Standardize editor configs for cross-platform development (#628) May 3, 2018
.eslintignore feat(v2): @docusaurus/init package (#1655) Jul 13, 2019
.eslintrc.js chore(v2): tweak eslint config (#1445) May 9, 2019
.gitattributes Add .webp to .gitattributes for ignoring May 3, 2018
.gitignore feat(v2): @docusaurus/init package (#1655) Jul 13, 2019
.prettierignore feat(v2): @docusaurus/init package (#1655) Jul 13, 2019
.prettierrc refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) May 20, 2019
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) Dec 18, 2017
CHANGELOG-2.x.md refactor(v2): remove unused metadata for pages (#1694) Jul 23, 2019
CHANGELOG.md v1.12.0 (#1679) Jul 20, 2019
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Aug 1, 2018
CONTRIBUTING.md misc: update CONTRIBUTING.md Jun 2, 2019
LICENSE The complete move to MIT license (#115) Oct 5, 2017
LICENSE-docs Docusaurus documentation license (#118) Oct 6, 2017
README.md misc: CircleCI badge in README (#1623) Jun 23, 2019
babel.config.js refactor(v2): migrate to Typescript ❄️🌀🐋 (#1490) May 18, 2019
crowdin.yaml chore: disable low % translated language and fold docs <= 1.9.x (#1685) Jul 21, 2019
jest.config.js fix: reload siteConfig.js automatically when locally served page is r… May 22, 2019
lerna.json v2.0.0-alpha.24 Jul 24, 2019
package.json feat(v2): use contenthash instead of chunkhash for longterm caching (#… Jul 21, 2019
tsconfig.json refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494) May 20, 2019
yarn.lock chore(v2): upgrade deps and add missing docs on docusaurus config (#1693 Jul 23, 2019

README.md

Docusaurus

Docusaurus

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

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 on npm.

We have also released the docusaurus-init package 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 contain bugs which are fairly easy to fix. 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.

You can’t perform that action at this time.