3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 18:27:56 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
922 commits 46 branches 176 tags 870 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Endilie Yacop Sucipto 3971f803bc
chore: add prerelease script (#876) 
* chore: add prerelease script

* Update prerelease.md

* Update prerelease.sh

* Update prerelease.sh

* chore: address review

* update instruction

* alias 'run version' to make it clear we're running docs version

* indicate that we are creating commit, not pull request

* update asciinema preview

* nits
2018-08-02 01:10:11 +08:00
.circleci Upgrade CircleCI docker image to Node 8 2018-07-08 09:54:46 -07:00
.github Standardize issue templates 2018-07-06 01:04:41 -07:00
admin chore: add prerelease script (#876) 2018-08-02 01:10:11 +08:00
docs Fix table of contents documentation typo (#873) 2018-07-27 11:07:56 +07:00
docusaurus-init Bump docusaurus-init to 1.0.2 (#788) 2018-06-19 07:33:24 -07:00
examples ESLintify Part 3 (#846) 2018-07-11 18:21:31 +08:00
lib chore: delete unused/ old file (#881) 2018-08-02 00:52:50 +08:00
scripts chore: add prerelease script (#876) 2018-08-02 01:10:11 +08:00
website Add atalaya.io to users (#878) 2018-07-30 22:35:05 -07:00
.babelrc Refactor + add more tests (Part 2) (#854) 2018-07-16 01:45:23 -07:00
.editorconfig Standardize editor configs for cross-platform development (#628) 2018-05-03 10:23:21 -07:00
.eslintignore Tidy up ESLint usage (#836) 2018-07-07 15:25:14 +07:00
.eslintrc.js ESLintify Part 3 (#846) 2018-07-11 18:21:31 +08:00
.gitattributes Add .webp to .gitattributes for ignoring 2018-05-03 13:13:03 -07:00
.gitignore add documentation regarding usage of nested docs + git ignore .idea (#860) 2018-07-19 16:07:32 +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.3.2 (#835) 2018-07-06 01:05:11 -07:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-07-31 19:49:46 -07:00
CONTRIBUTING.md Better issue templates (#833) 2018-07-05 22:55:18 -07:00
crowdin.yaml Enable sub-directories in docs/ (#705) 2018-06-07 07:41:28 -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.json chore: delete unused/ old file (#881) 2018-08-02 00:52:50 +08:00
README.md More attractive README introduction (#866) 2018-07-20 11:13:02 -07:00
yarn.lock Add autoprefixing to CSS pipeline (#867) 2018-07-22 00:05:13 -07:00

README.md

Docusaurus

Docusaurus

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

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