Easy to maintain open source documentation websites.
Find a file
Richard Zhang a5e963dba1 Issue 305 broken link because of language fixes (#322)
* without having having to worry about site design.

Let me know if double having is intentional

* distinguish case of no translation and en lang

* prettier recommends

* distinguish case of no translation and en lang

* prettier recommends

* merge with latest origin/master changes

* typo

* link with language fixes

* do not show language dropdown if only one enabled

* check translation outside of LanguageDropDown.render
2017-12-19 17:44:43 -08:00
.circleci Switch to rsync package (#320) 2017-12-19 12:34:12 -08:00
.github Add Issue and Pull request templates 2017-12-12 11:14:50 -08:00
admin Fixes to testing guide (for Windows only) (#304) 2017-12-18 11:48:53 -08:00
docs Fix broken or redirected links (#302) 2017-12-17 16:44:07 -08:00
docusaurus-init A bunch of tiny little fixes for issues I found while setting up docusaurus (#312) 2017-12-18 09:26:33 -08:00
examples Issue 305 broken link because of language fixes (#322) 2017-12-19 17:44:43 -08:00
lib Issue 305 broken link because of language fixes (#322) 2017-12-19 17:44:43 -08:00
website Fix zh-Hans' Chinese word & Beautify code (#311) 2017-12-19 12:31:28 -08:00
.gitignore Organize .gitignore and add website/package-lock.json (#199) 2017-10-30 16:16:57 -07:00
.npmignore Add docusaurus-init package and update copy-examples.js (#70) 2017-09-06 13:00:45 -07:00
.prettierrc Update prettier to 1.9.1 (#273) 2017-12-12 12:47:52 -08:00
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) 2017-12-18 14:40:52 -08:00
CHANGELOG.md Add a change log 2017-12-19 15:53:18 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#281) 2017-12-13 07:23:10 -08:00
CONTRIBUTING.md Add running Jest tests to CONTRIBUTING.md 2017-12-18 14:48:13 -08:00
crowdin.yaml Re-arranging of files to move localized base files in /docs from /docs/en, updates to template crowdin.yaml, update to package.json to make calling crowdin easier. Updating documentation to reflect. 2017-09-21 08:36:30 -07:00
LICENSE The complete move to MIT license (#115) 2017-10-05 11:14:49 -07:00
LICENSE-docs Docusaurus documentation license (#118) 2017-10-06 12:59:01 -07:00
package-lock.json Update package and yarn lock files 2017-12-18 14:44:57 -08:00
package.json Switch rsync for fs-extra (#321) 2017-12-19 13:29:41 -08:00
README.md More README updates 2017-12-11 17:25:19 -08:00
yarn.lock Switch rsync for fs-extra (#321) 2017-12-19 13:29:41 -08:00

Docusaurus · CircleCI npm version PRs Welcome

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

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.