mirror of https://github.com/facebook/docusaurus.git synced 2025-07-29 22:47:52 +02:00

History

Fienny Angelina a1d36be61c fix: make referenced links work with code block tabs (#1249 ) * Fix bug Code block tabs broke the referenced links - The reason is that the previous Codeblock implementation separates the tabs, the markdown before tabs, and the markdown after tabs into separate Remarkable component, thus they don't share information regarding the reference link - To solve this, change the Doc implementation so that one Doc have only one Remarkable component by transforming the codeblock into html string and add it as part of the markdown, letting the Remarkable take care of the html string - However, this approach made us need to ensure that there is no newline in the codetab, otherwise, the formatting inside the code will be broken. Thus, I replace every newline inside the code tag with a br tag Fix #1215 * Fix prettier		2019-02-26 08:56:30 -08:00
..
docusaurus-init	Move Docusaurus 1 files into directory (#966 )	2018-09-18 00:58:07 +08:00
examples	Update code.facebook.com links to appropriate new destination (#1224 )	2019-02-06 14:29:17 -08:00
lib	fix: make referenced links work with code block tabs (#1249 )	2019-02-26 08:56:30 -08:00
website	docs: update CaptainDuckDuck to CapRover (#1244 )	2019-02-23 07:25:31 -08:00
.eslintignore	Move Docusaurus 1 files into directory (#966 )	2018-09-18 00:58:07 +08:00
.eslintrc.js	fix: turn off react/no-array-index-key lint rule	2019-01-23 23:34:13 -08:00
.gitignore	Move Docusaurus 1 files into directory (#966 )	2018-09-18 00:58:07 +08:00
.npmignore	Move Docusaurus 1 files into directory (#966 )	2018-09-18 00:58:07 +08:00
babel.config.js	chore(v1): add Facebook copyright headers (#1068 )	2018-10-25 17:30:38 -07:00
crowdin.yaml	chore: move v1 crowdin yaml to right place (#993 )	2018-09-28 18:52:29 +08:00
jest.transform.js	chore(v1): add Facebook copyright headers (#1068 )	2018-10-25 17:30:38 -07:00
package.json	chore(v2): remove prettier from specific projects	2019-02-23 14:28:32 -08:00
README.md	chore: add README to v1 (#1031 )	2018-10-14 14:41:19 -07:00
yarn.lock	chore(v2): remove prettier from specific projects	2019-02-23 14:28:32 -08:00

README.md

Docusaurus

npm version

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.

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