blakeblackshear.frigate/docs
2021-02-20 08:20:17 -06:00
..
docs update docker commands to avoid privileged mode 2021-02-20 08:20:17 -06:00
src/css docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
static tweaking the docs 2021-01-26 21:40:33 -06:00
.gitignore docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
babel.config.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
docusaurus.config.js updating for docusaurus2 docs 2021-01-26 21:40:33 -06:00
package-lock.json docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
package.json docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
README.md docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00
sidebars.js docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00

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.