docusaurus/v1
Yangshun Tay d89401b47e feat: change landing page hero (#1290)
* docs: add v2 roadmap to landing page

* feat: change landing page hero

* fix: remove CSS test as it doesn't account for autoprefixing
2019-03-20 16:54:42 +07: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 feat: change landing page hero (#1290) 2019-03-20 16:54:42 +07:00
website feat: change landing page hero (#1290) 2019-03-20 16:54:42 +07: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 v1.7.3 (#1286) 2019-03-19 23:01:05 -07:00
README.md chore: add README to v1 (#1031) 2018-10-14 14:41:19 -07:00
yarn.lock fix: upgrade jest to remove security vulnerability (#1267) 2019-03-07 16:15:59 +08:00

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.

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

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.