lookingglass/docs
2020-06-02 01:52:13 -07:00
..
docs add hyperglass-agent docs; main styling 2020-06-02 01:39:25 -07:00
screenshots docs 2020-02-08 00:58:32 -07:00
src fix logo styling [skip ci] 2020-06-02 01:52:13 -07:00
static/img fix docs images 2020-02-08 08:36:32 -07:00
.gitignore docs 2020-02-08 00:58:32 -07:00
docusaurus.config.js ui improvements 2020-06-02 01:37:26 -07:00
package.json ui improvements 2020-06-02 01:37:26 -07:00
README.md docs 2020-02-08 00:58:32 -07:00
sidebars.js add more hyperglass-agent docs 2020-06-02 01:37:56 -07:00
yarn.lock ui improvements 2020-06-02 01:37:26 -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.