History

Joel Speed c8a70c6243 Add version dropdown to docs header		2020-11-08 19:37:46 +00:00
..
docs	Flip `--skip-auth-strip-headers` to `true` by default	2020-11-07 11:43:45 -08:00
src	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
static	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
versioned_docs/version-6.1.x	Set up docs for version 6.1.x	2020-11-08 19:37:43 +00:00
versioned_sidebars	Set up docs for version 6.1.x	2020-11-08 19:37:43 +00:00
.gitignore	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
babel.config.js	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
docusaurus.config.js	Add version dropdown to docs header	2020-11-08 19:37:46 +00:00
package-lock.json	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
package.json	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
README.md	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
sidebars.js	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
versions.json	Set up docs for version 6.1.x	2020-11-08 19:37:43 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.