3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
282 commits 47 branches 176 tags 868 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Joel Marcey 9274b2a849 Add back babel preset for React plugins package 
This fixes the circular JSON error in https://github.com/facebookexperimental/Docusaurus/issues/89

Maybe its not the best workaround here, but I think it does the trick.

Fixes #89
2017-10-02 18:57:58 -07:00
docs Remove duplicative publish doc 2017-09-29 15:38:58 -07:00
docusaurus-init Add docusaurus-init package and update copy-examples.js (#70) 2017-09-06 13:00:45 -07:00
examples 2 bug fixes (#98) 2017-09-28 14:46:29 -07:00
lib 2 bug fixes (#98) 2017-09-28 14:46:29 -07:00
website Remove duplicative publish doc 2017-09-29 15:38:58 -07:00
.gitignore 2 bug fixes (#98) 2017-09-28 14:46:29 -07:00
.npmignore Add docusaurus-init package and update copy-examples.js (#70) 2017-09-06 13:00:45 -07:00
circle.yml Add ssh option to publish script 2017-08-16 16:42:31 -07: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 Initial commit 2017-07-07 10:28:29 -07:00
package.json Add back babel preset for React plugins package 2017-10-02 18:57:58 -07:00
PATENTS Initial commit 2017-07-07 10:28:29 -07:00
README.md Update README, clean up getting started sections (#100) 2017-09-29 15:38:03 -07:00
yarn.lock 2 bug fixes (#98) 2017-09-28 14:46:29 -07:00

README.md

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

React is ? licensed.

React documentation is ? licensed.