lookingglass/docs
2021-01-01 01:50:36 -07:00
..
docs Merge branch 'v1.0.0' into ui-refactor 2021-01-01 01:50:36 -07:00
screenshots docs 2020-02-08 00:58:32 -07:00
src docs: fix homepage text size 2020-09-05 14:37:51 -07:00
static add YAML anchor/alias examples 2020-07-17 00:56:13 -07:00
.gitignore docs 2020-02-08 00:58:32 -07:00
docusaurus.config.js update docusaurus 2020-07-17 00:54:35 -07:00
generateSitemap.js SEO improvements 2020-06-06 01:41:10 -07:00
package.json update docusaurus 2020-07-17 00:54:35 -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
yarn.lock update docusaurus 2020-07-17 00:54:35 -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.