Skip to content

/ docusaurus

Easy to maintain open source documentation websites.
documentation website javascript react open-source
JavaScript TypeScript CSS Other
  1. JavaScript 61.5%
  2. TypeScript 29.3%
  3. CSS 9.0%
  4. Other 0.2%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@lex111
lex111 fix(v2): enable scrolling for sidebar menu only (#2645) 
* fix(v2): enable scrolling for sidebar menu only

* Add support for announcement bar

* fix: remove redundant styles
Latest commit d391a2b May 26, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: drop support for node <10.9 (#2207) Jan 12, 2020
.github misc: update CODEOWNERS Apr 24, 2020
admin chore: prettier May 23, 2020
docs docs(v2): add mention on DocSearch when you run the crawler on your o… May 25, 2020
jest chore(v2): fix code style (revert previous changes) Apr 5, 2020
packages fix(v2): enable scrolling for sidebar menu only (#2645) May 25, 2020
website-1.x v2.0.0-alpha.55 May 19, 2020
website docs(v2): add trailing slash to external links (#2801) May 24, 2020
.editorconfig Standardize editor configs for cross-platform development (#628) May 3, 2018
.eslintignore fix(v2): fix plugin-ideal-image breaking website (exports not defined) ( Dec 1, 2019
.eslintrc.js feat(v2): bootstrap bootstrap (heh) theme, preset, template (#2557) Apr 9, 2020
.gitattributes Add .webp to .gitattributes for ignoring May 3, 2018
.gitignore chore(v2): ignore JetBrains editor .iml files (#2433) Mar 21, 2020
.gitpod.yml feat: add Gitpod config for Docusaurus 2 (#2201) Jan 12, 2020
.nvmrc chore: drop support for node <10.9 (#2207) Jan 12, 2020
.prettierignore style(v2): disable Prettier checks for Markdown files of init templat… May 22, 2020
.prettierrc chore(v2): update Prettier config (#2542) Apr 5, 2020
.stylelintrc.js fix(v2): improve stylelint copyright header rule (#2363) Mar 7, 2020
.watchmanconfig misc(v2): make watchman config valid Mar 24, 2020
CHANGELOG-2.x.md chore(v2): v2.0.0-alpha.55 (#2774) May 19, 2020
CHANGELOG.md chore: prepare for v1.14.4 release (#2211) Jan 12, 2020
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Aug 1, 2018
CONTRIBUTING.md misc: update test plan in contributing (#2679) Apr 27, 2020
LICENSE chore: yearless copyright headers for source code (#2320) Feb 25, 2020
LICENSE-docs Docusaurus documentation license (#118) Oct 6, 2017
README.md misc: add special thanks section in README file (#2482) Mar 29, 2020
babel.config.js chore: yearless copyright headers for source code (#2320) Feb 25, 2020
crowdin.yaml chore: download only enabled languages translation files Jul 26, 2019
jest.config.js fix(v2): use lodash instead of array-map-polyfill (#2490) Apr 1, 2020
lerna.json v2.0.0-alpha.55 May 19, 2020
package.json refactor(v2): import lqip-loader, fix build on Node 13 (#2544) Apr 5, 2020
tsconfig.json feat(v2): allow nested sidebar category shorthand syntax (#2444) Mar 25, 2020
yarn.lock feat(v2): Use pnp-webpack-plugin to support pnp module resolution (#2796 May 23, 2020

README.md

Docusaurus

Docusaurus

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

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

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.

Special thanks

BrowserStack logo

BrowserStack supports us with free access for open source.

Rocket Validator logo

Rocket Validator helps us find HTML markup or accessibility issues.

You can’t perform that action at this time.