mirrors/thatmattlove-hyperglass
1
0
Fork 1
mirror of https://github.com/thatmattlove/hyperglass.git synced 2026-01-17 08:48:05 +00:00
Code Issues Activity
thatmattlove-hyperglass/docs
History
checktheroads eea833ed44 Update GitHub username
2021-06-23 19:22:30 -07:00
..
docs Update GitHub username 2021-06-23 19:22:30 -07:00
screenshots docs 2020-02-08 00:58:32 -07:00
src Fix docs errors 2021-05-30 16:32:03 -07:00
static Migrate to hyperglass.dev domain 2021-05-31 18:31:14 -07:00
.gitignore Update docs framework 2021-05-30 12:03:18 -07:00
docusaurus.config.js Update GitHub username 2021-06-23 19:22:30 -07:00
generateSitemap.js Migrate to hyperglass.dev domain 2021-05-31 18:31:14 -07:00
package.json Update docs framework 2021-05-30 12:03:18 -07:00
README.md docs 2020-02-08 00:58:32 -07:00
sidebars.js docs: add agent parameters 2020-09-05 14:37:16 -07:00
tsconfig.json Update docs framework 2021-05-30 12:03:18 -07:00
yarn.lock Update docs framework 2021-05-30 12:03:18 -07:00

README.md

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.