sandwich/sandwich-site
2023-11-18 23:10:08 -08:00
..
blog More golden 2022-07-20 16:42:13 -07:00
docs Fix a couple more references to nested-dependencies 2023-11-18 23:10:08 -08:00
src Fix demos link 2021-07-23 02:05:24 -07:00
static Writing markdown summary formatter docs 2022-07-17 18:11:40 -07:00
.gitignore Check in docusaurus v2 site 2021-02-25 21:00:56 -08:00
babel.config.js Check in docusaurus v2 site 2021-02-25 21:00:56 -08:00
docusaurus.config.js Working on demos, docs 2021-05-02 14:44:17 -07:00
package-lock.json Starting to work on hedgehog documentation 2022-07-14 02:41:07 -07:00
package.json Site progress 2021-05-10 15:21:33 -06:00
README.md Check in docusaurus v2 site 2021-02-25 21:00:56 -08:00
sidebars.js Writing markdown summary formatter docs 2022-07-17 18:11:40 -07:00
yarn.lock Starting to work on hedgehog documentation 2022-07-14 02:41:07 -07: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.