1
0
Fork 1
mirror of https://github.com/thatmattlove/hyperglass.git synced 2026-01-17 08:48:05 +00:00
thatmattlove-hyperglass/docs
checktheroads 626f562dc0 fix title
2020-02-08 01:04:44 -07:00
..
docs docs 2020-02-08 00:58:32 -07:00
screenshots docs 2020-02-08 00:58:32 -07:00
src fix title 2020-02-08 01:04:44 -07:00
static/img docs 2020-02-08 00:58:32 -07:00
.gitignore docs 2020-02-08 00:58:32 -07:00
docusaurus.config.js fix title 2020-02-08 01:04:44 -07:00
package.json docs 2020-02-08 00:58:32 -07:00
README.md docs 2020-02-08 00:58:32 -07:00
sidebars.js docs 2020-02-08 00:58:32 -07:00
yarn.lock docs 2020-02-08 00:58:32 -07:00

Website

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

Installation

$ yarn

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.