Blake Blackshear 4a74f295e7 docs updates 4 éve
..
docs 4a74f295e7 docs updates 4 éve
src 6790467bbc docs: move docs to docusaurus 4 éve
static 27b659dde1 tweaking the docs 4 éve
.gitignore 6790467bbc docs: move docs to docusaurus 4 éve
README.md 6790467bbc docs: move docs to docusaurus 4 éve
babel.config.js 6790467bbc docs: move docs to docusaurus 4 éve
docusaurus.config.js 15b5ffddd4 updating for docusaurus2 docs 4 éve
package-lock.json 6790467bbc docs: move docs to docusaurus 4 éve
package.json 6790467bbc docs: move docs to docusaurus 4 éve
sidebars.js 6790467bbc docs: move docs to docusaurus 4 éve

README.md

Website

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

Installation

yarn install

Local Development

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.

Build

yarn build

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

Deployment

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.