mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 18:27:56 +02:00

Easy to maintain open source documentation websites.

documentation hacktoberfest javascript open-source react website

Find a file

Bartosz Kaszubowski 73f151d04c chore(internal): add yarn deduplicate script, cleanup lock (#3738 ) * chore(internal): add yarn deduplicate script, cleanup lock * add lock cleanup to postinstall, install run and optimize lock again		2020-11-13 14:21:04 +01:00
.circleci	chore: drop support for node <10.9 (#2207 )	2020-01-12 13:24:11 +08:00
.github	test(e2e): dogfood Yarn with enableGlobalCache (#3673 )	2020-11-02 18:21:03 +01:00
__tests__	fix: add repository metadata to all packages (#3613 )	2020-10-21 15:05:01 +02:00
admin	chore(v2): fix unbound env variable in test release script (#3641 )	2020-10-26 15:10:04 +01:00
jest	chore(v2): fix code style (revert previous changes)	2020-04-05 17:38:12 +03:00
packages	feat(v2): introduce new minification of CSS bundle (#3716 )	2020-11-13 14:06:24 +01:00
website	docs(v2): add Inline SVG color override example (#3737 )	2020-11-13 14:17:22 +01:00
website-1.x	docs(v1): fix typo on Add Versions doc page (#3651 )	2020-10-28 15:24:15 +03:00
.editorconfig	Standardize editor configs for cross-platform development (#628 )	2018-05-03 10:23:21 -07:00
.eslintignore	feat(v2): migrate bootstrap components to ts (#3496 )	2020-09-29 13:16:39 +02:00
.eslintrc.js	fix(v2): Add missing dependencies to packages (#3355 )	2020-08-28 15:04:44 +02:00
.gitattributes	Add .webp to .gitattributes for ignoring	2018-05-03 13:13:03 -07:00
.gitignore	fix(v1): v1 deploy preview should be available (#3517 )	2020-10-02 14:58:06 +02: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	feat(v2): markdown pages (#3158 )	2020-07-31 16:04:56 +02:00
.prettierrc	chore(v2): update Prettier config (#2542 )	2020-04-05 23:51:47 +08:00
.stylelintrc.js	fix(v2): improve stylelint copyright header rule (#2363 )	2020-03-07 11:49:52 +08:00
.watchmanconfig	misc(v2): make watchman config valid	2020-03-24 12:17:00 +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): prepare v2.0.0.alpha-66 release (#3608 )	2020-10-19 19:44:26 +02:00
CHANGELOG.md	docs: corrected some few typos in the docusaurus tech docs (#3276 )	2020-08-14 11:38:54 +02:00
CODE_OF_CONDUCT.md	Update CODE_OF_CONDUCT.md	2018-07-31 19:49:46 -07:00
CONTRIBUTING.md	docs(v2): docs typos (#3252 )	2020-08-11 13:51:00 +02:00
crowdin.yaml	chore(v1): move v1 docs inside website-1.x (#3504 )	2020-10-01 17:16:24 +02:00
jest.config.js	feat(v2): markdown pages (#3158 )	2020-07-31 16:04:56 +02:00
lerna.json	chore(v2): prepare v2.0.0.alpha-66 release (#3608 )	2020-10-19 19:44:26 +02: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	chore(internal): add yarn deduplicate script, cleanup lock (#3738 )	2020-11-13 14:21:04 +01:00
README.md	docs: remove runme (#3630 )	2020-10-23 17:35:55 +02:00
tsconfig.json	chore(v2): tighten up the TypeScript onboarding (#3244 )	2020-08-17 18:03:21 +02:00
yarn.lock	chore(internal): add yarn deduplicate script, cleanup lock (#3738 )	2020-11-13 14:21:04 +01: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 building, deploying, and maintaining open source project websites easily.

Simple to Start

Docusaurus is built in a way so that it can get running in as little time as 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