3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 10:48:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
1539 commits 46 branches 176 tags 870 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
TurekBot be149e182f docs: clarify location of sidebars.json (#1472) 
In #1468 we clarify where the `docs` folder is. 
Here, we make it clear where `sidebars.json` is.
2019-05-16 19:29:02 -07:00
.circleci chore(v2): rm flowtype (#1444) 2019-05-09 18:32:56 +07:00
.github fix: update paths for monorepo 2019-03-23 21:53:32 -07:00
admin chore: update prerelease.sh & prerelease.md (#886) 2018-08-03 20:24:09 +08:00
docs docs: clarify location of sidebars.json (#1472) 2019-05-16 19:29:02 -07:00
packages fix(v2): fix cannot import css from node_modules in userland (#1463) 2019-05-16 20:13:00 +07:00
scripts chore: fix conflicting yarn 'version' 2019-04-10 22:01:37 +08:00
website v2.0.0-alpha.16 2019-05-16 16:01:52 +08:00
website-1.x docs: normalized spelling of web server (#1473) 2019-05-16 19:28:22 -07:00
.editorconfig Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.eslintignore chore(v2): rm flowtype (#1444) 2019-05-09 18:32:56 +07:00
.eslintrc.js chore(v2): tweak eslint config (#1445) 2019-05-09 20:01:48 +07:00
.gitattributes Add .webp to .gitattributes for ignoring 2018-05-03 13:13:03 -07:00
.gitignore chore(v2): rm flowtype (#1444) 2019-05-09 18:32:56 +07:00
.prettierignore chore(v2): rm flowtype (#1444) 2019-05-09 18:32:56 +07:00
.prettierrc Prettify all JavaScript files (#964) 2018-09-17 15:34:55 +08:00
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) 2017-12-18 14:40:52 -08:00
babel.config.js chore(v2): rm flowtype (#1444) 2019-05-09 18:32:56 +07:00
CHANGELOG.md chore(v2): fix typo 2019-05-15 19:35:14 +08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-07-31 19:49:46 -07:00
CONTRIBUTING.md misc: make v1 docs MDX-compatible (#1318) 2019-03-29 19:20:26 +07:00
crowdin.yaml fix: broken links due to monorepo migration 2019-03-26 22:03:53 -07:00
jest.config.js refactor(v2): add flowtype + refactor test (#1443) 2019-05-08 23:03:52 +07:00
lerna.json v2.0.0-alpha.16 2019-05-16 16:01:52 +08: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.json chore(v2): update dependencies (#1462) 2019-05-16 14:33:32 +07:00
README.md chore: fix typo (#1466) 2019-05-16 11:53:10 -07:00
yarn.lock fix(v2): fix cannot import css from node_modules in userland (#1463) 2019-05-16 20:13:00 +07:00

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.