mirror of https://github.com/facebook/docusaurus.git synced 2024-11-25 16:46:13 +08:00

Easy to maintain open source documentation websites.

documentation hacktoberfest javascript open-source react website

Go to file

Sébastien Lorber e5bdb0b97d chore(ci): retry `yarn install` to ignore temporary network errors (#10691 )		2024-11-18 11:09:12 +01:00
__tests__	chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (#10256 )	2024-07-01 17:34:40 +02:00
.devcontainer
.github	chore(ci): retry `yarn install` to ignore temporary network errors (#10691 )	2024-11-18 11:09:12 +01:00
.husky
.vscode
admin	chore: release Docusaurus 3.6.1 (#10659 )	2024-11-08 18:47:43 +01:00
argos	chore: release Docusaurus 3.6.1 (#10659 )	2024-11-08 18:47:43 +01:00
examples	chore: update examples with docusaurus 3.6 (#10642 )	2024-11-04 12:31:10 +01:00
jest
packages	fix(theme-translation): complete and fix Japanese translations (#10688 )	2024-11-18 09:35:00 +01:00
website	docs: fix description of `feedOptions.xslt` (#10687 )	2024-11-16 01:31:56 -05:00
.cspell.json	feat(blog): add feed xlst options to render beautiful RSS and Atom feeds (#9252 )	2024-08-02 18:50:48 +02:00
.editorconfig
.eslintignore	fix(core): bundler should not minimize static assets (#10658 )	2024-11-08 18:26:37 +01:00
.eslintrc.js	chore: Rename Twitter links/labels to X (#10509 )	2024-09-19 11:30:57 +02:00
.gitattributes
.gitignore	fix(core): fix i18n sites SSG memory leak - require.cache (#10599 )	2024-10-22 12:40:57 +02:00
.gitpod.yml
.lintstagedrc.json
.nvmrc
.prettierignore	fix(core): bundler should not minimize static assets (#10658 )	2024-11-08 18:26:37 +01:00
.prettierrc
.stylelintignore	fix(core): bundler should not minimize static assets (#10658 )	2024-11-08 18:26:37 +01:00
.stylelintrc.js
.watchmanconfig
CHANGELOG.md	chore: release Docusaurus 3.6.1 (#10659 )	2024-11-08 18:47:43 +01:00
CODE_OF_CONDUCT.md	docs: rename Facebook to Meta in GitHub-related Markdowns (#10566 )	2024-10-09 09:17:53 +02:00
CONTRIBUTING.md	docs: rename Facebook to Meta in GitHub-related Markdowns (#10566 )	2024-10-09 09:17:53 +02:00
crowdin-v2.yaml
jest.config.mjs
lerna.json	chore: release Docusaurus 3.6.1 (#10659 )	2024-11-08 18:47:43 +01:00
LICENSE
LICENSE-docs
package.json	chore: Argos screenshot dogfooding test pages (#10650 )	2024-11-07 16:12:23 +01:00
project-words.txt	chore: Argos screenshot dogfooding test pages (#10650 )	2024-11-07 16:12:23 +01:00
README.md	docs: rename Facebook to Meta in GitHub-related Markdowns (#10566 )	2024-10-09 09:17:53 +02:00
tsconfig.base.client.json	chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (#10256 )	2024-07-01 17:34:40 +02:00
tsconfig.base.json	chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (#10256 )	2024-07-01 17:34:40 +02:00
yarn.lock	fix(bundler): allow CSS nesting by default, restore postcss-preset-env (#10680 )	2024-11-15 15:58:34 +01:00

README.md

Docusaurus

Introduction

Docusaurus is a project for building, deploying, and maintaining open source project websites easily.

Short on time? Check out our 5-minute tutorial ⏱️!

Tip: use docusaurus.new to test Docusaurus immediately in a playground.

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

Use the initialization CLI to create your site:

npm init docusaurus@latest

Read the docs for any further information.

Contributing

We've released Docusaurus because it helps us better scale and supports the many OSS projects at Meta. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

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