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.
745 commits 47 branches 176 tags 868 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Amy Lam 7fa0f910ac On mobile, hide title if logo exists (#629) 
* On mobile, hide title if logo exists

* Run Prettier, use ternary, reorder

* Rename class for clarity

* Update main.css
2018-05-03 10:54:25 -07:00
.circleci Add translations to Circle config (#549) 2018-04-12 08:34:27 -07:00
.github Add Docusaurus version to issue template 2018-04-24 10:25:07 -07:00
admin Use proper syntax highlighting for code blocks (#615) 2018-04-27 22:51:38 -07:00
docs Fix assets directory path in "Tips & Tricks" (#630) 2018-05-03 08:16:15 -07: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 Fix example site's user image path (#605) 2018-04-25 12:29:25 -07:00
lib On mobile, hide title if logo exists (#629) 2018-05-03 10:54:25 -07:00
website Add author Twitter handle to blog (#626) 2018-05-03 10:49:57 -07:00
.babelrc Use cssnano to minify main CSS file (#569) 2018-04-16 21:31:01 -07:00
.editorconfig Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.gitattributes Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.gitignore Revert yarn prettier addition in yarn ci-check (#543) 2018-04-10 10:30:29 -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 Publish v1.0.14 (#597) 2018-04-23 16:40:13 -07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#281) 2017-12-13 07:23:10 -08:00
CONTRIBUTING.md Use proper syntax highlighting for code blocks (#615) 2018-04-27 22:51:38 -07:00
crowdin.yaml i18n: use zh-TW and zh-CN over zh-Hant and zh-Hans (#377) 2018-01-11 15:40:53 -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-lock.json Publish v1.0.14 (#597) 2018-04-23 16:40:13 -07:00
package.json Publish v1.0.14 (#597) 2018-04-23 16:40:13 -07:00
README.md Fix documentation link issue (#591) 2018-04-22 23:47:30 -07:00
yarn.lock Use cssnano to minify main CSS file (#569) 2018-04-16 21:31:01 -07:00

README.md

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.

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

License

Docusaurus is MIT licensed.

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