3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-28 09:47:48 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
2158 commits 47 branches 176 tags 867 MiB
TypeScript 88.3%
HTML 5.9%
JavaScript 2.8%
CSS 2%
XSLT 0.8%
Find a file
Nisar Hassan Naqvi 7f3829124b feat: add Gitpod config for Docusaurus 2 (#2201) 
* feat: fully automates dev setup with gitpod.

* Update .gitpod.yml

* Update README.md

Co-authored-by: Yangshun Tay <tay.yang.shun@gmail.com>
2020-01-12 12:33:21 +08:00
.circleci chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
.github misc: do not disturb Endi (#2197) 2020-01-08 01:17:37 +08:00
admin misc: add command to run prettier on docs (#2102) 2019-12-07 21:56:30 -08:00
docs docs: promote Docusaurus 2 usage (#2126) 2019-12-15 17:49:25 +08:00
packages fix(v1): update blog href value to match navbar href (#2204) 2020-01-11 13:19:01 +08:00
scripts misc: use /usr/bin/env bash to increase portability (#1923) 2019-11-03 22:29:16 +08:00
website misc: do not disturb Endi (#2197) 2020-01-08 01:17:37 +08:00
website-1.x blog: tribute to Endi (#2194) 2020-01-07 13:22:07 +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 chore(v2): turn off import/extensions ESLint rule 2019-12-22 11:34:44 +08:00
.gitattributes Add .webp to .gitattributes for ignoring 2018-05-03 13:13:03 -07:00
.gitignore refactor(v2): convert @docusaurus/plugin-ideal-image to TypeScript (#2011) 2019-11-30 16:09:26 -08:00
.gitpod.yml feat: add Gitpod config for Docusaurus 2 (#2201) 2020-01-12 12:33:21 +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
.watchmanconfig Add first set of docusaurus-build tests using Jest (#259) 2017-12-18 14:40:52 -08:00
babel.config.js chore: bump dev dependencies (#1955) 2019-11-11 17:44:26 +07:00
CHANGELOG-2.x.md chore(v2): prepare alpha.40 release (#2146) 2019-12-25 16:30:29 +07:00
CHANGELOG.md misc: add command to run prettier on docs (#2102) 2019-12-07 21:56:30 -08:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-07-31 19:49:46 -07:00
CONTRIBUTING.md misc: add command to run prettier on docs (#2102) 2019-12-07 21:56:30 -08:00
crowdin.yaml chore: download only enabled languages translation files 2019-07-26 23:07:04 +07:00
jest.config.js fix(v2): docs plugin stability improvement (100% test coverage) (#1912) 2019-10-29 23:59:27 +08:00
lerna.json v2.0.0-alpha.40 2019-12-25 16:41:52 +07:00
LICENSE The complete move to MIT license (#115) 2017-10-05 11:14:49 -07:00
LICENSE-docs Docusaurus documentation license (#118) 2017-10-06 12:59:01 -07:00
package.json docs(v2): fix pages routing inaccurate info (#2110) 2019-12-10 12:47:13 -08:00
README.md feat: add Gitpod config for Docusaurus 2 (#2201) 2020-01-12 12:33:21 +08: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 feat(v2): add ESLint to Facebook template (#2155) 2019-12-29 16:39:28 +08:00

README.md

Docusaurus

Docusaurus

npm version CircleCI status PRs Welcome Chat code style: prettier Tested with Jest Gitpod Ready-to-Code Netlify Status

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.

Contribute online with a single click

You can use Gitpod (a free, online, VS Code-based IDE) for contributing. It will launch a ready to code workspace (for Docusaurus 2) with all the dependencies installed and the development server running so that you can start contributing straight away.

Open in Gitpod

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

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.