mirror of https://github.com/facebook/docusaurus.git synced 2025-04-28 17:57:48 +02:00

Easy to maintain open source documentation websites.

documentation hacktoberfest javascript open-source react website

Find a file

Ben Gubler a8a4fe467a polish(v2): use npm-to-yarn for the npm2yarn remark plugin (#2428 ) * Use npm-to-yarn for the Bash npm2yarn Remark plugin * Update npm-to-yarn version with fix * Update npm-to-yarn yet another time to fix another -g/--global bug * Update remark-npm2yarn.js Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>		2020-03-24 08:53:48 +08:00
.circleci	chore: drop support for node <10.9 (#2207 )	2020-01-12 13:24:11 +08:00
.github	Fix docs style (#2322 )	2020-02-26 03:22:25 +03:00
admin	chore: add npm publishing instructions (#2288 )	2020-02-16 23:38:12 +08:00
docs	docs(v1): fix Windows instructions for GitHub Pages publishing (#2307 )	2020-02-21 09:46:13 +08:00
jest	misc: update stylelint rule tester	2020-03-21 15:22:25 +08:00
packages	fix(v2): pass options to remark-admonitions (#2451 )	2020-03-24 08:42:41 +08:00
website	polish(v2): use npm-to-yarn for the npm2yarn remark plugin (#2428 )	2020-03-24 08:53:48 +08:00
website-1.x	docs: showcase user Day.js (#2388 )	2020-03-09 15:43:27 +08:00
.editorconfig	Standardize editor configs for cross-platform development (#628 )	2018-05-03 10:23:21 -07:00
.eslintignore	fix(v2): fix plugin-ideal-image breaking website (exports not defined) (#2074 )	2019-12-01 21:59:02 +07:00
.eslintrc.js	misc: update stylelint rule tester	2020-03-21 15:22:25 +08:00
.gitattributes	Add .webp to .gitattributes for ignoring	2018-05-03 13:13:03 -07:00
.gitignore	chore(v2): ignore JetBrains editor .iml files (#2433 )	2020-03-22 01:34:06 +08:00
.gitpod.yml	feat: add Gitpod config for Docusaurus 2 (#2201 )	2020-01-12 12:33:21 +08:00
.nvmrc	chore: drop support for node <10.9 (#2207 )	2020-01-12 13:24:11 +08:00
.prettierignore	misc: add command to run prettier on docs (#2102 )	2019-12-07 21:56:30 -08:00
.prettierrc	refactor(v2): migrate core to Typescript ❄️🌀🐋 (#1494 )	2019-05-20 09:59:04 -07:00
.stylelintrc.js	fix(v2): improve stylelint copyright header rule (#2363 )	2020-03-07 11:49:52 +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: yearless copyright headers for source code (#2320 )	2020-02-25 23:12:28 +08:00
CHANGELOG-2.x.md	chore(v2): v2.0.0-alpha.48 (#2387 )	2020-03-09 01:44:26 +03:00
CHANGELOG.md	chore: prepare for v1.14.4 release (#2211 )	2020-01-13 00:11:23 +08:00
CODE_OF_CONDUCT.md	Update CODE_OF_CONDUCT.md	2018-07-31 19:49:46 -07:00
CONTRIBUTING.md	misc: update Gitpod description (#2421 )	2020-03-17 19:59:09 +03:00
crowdin.yaml	chore: download only enabled languages translation files	2019-07-26 23:07:04 +07:00
jest.config.js	misc: update stylelint rule tester	2020-03-21 15:22:25 +08:00
lerna.json	v2.0.0-alpha.48	2020-03-09 01:46:10 +03:00
LICENSE	chore: yearless copyright headers for source code (#2320 )	2020-02-25 23:12:28 +08:00
LICENSE-docs	Docusaurus documentation license (#118 )	2017-10-06 12:59:01 -07:00
package.json	fix(v2): specify proper version for stylelint-copyright (#2383 )	2020-03-09 03:57:02 +08:00
README.md	misc: update Gitpod description (#2421 )	2020-03-17 19:59:09 +03:00
tsconfig.json	breaking(v2): required nodejs version >=8.9 -> >=8.10 so we can use es2017 (#2045 )	2019-11-24 21:40:57 -08:00
yarn.lock	misc: improve stylelint rule (#2415 )	2020-03-21 12:42:10 +08:00

README.md

Docusaurus

We are working hard on Docusaurus v2. If you are new to Docusaurus, try using the new version instead of v1. See the Docusaurus v2 website for more details.

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 might contain smaller issues to tackle first. 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