squiggle/docs
2022-02-06 13:40:28 -05:00
..
blog Added simple docusaurus site 2022-02-06 13:40:28 -05:00
docs Added simple docusaurus site 2022-02-06 13:40:28 -05:00
src Added simple docusaurus site 2022-02-06 13:40:28 -05:00
static Added simple docusaurus site 2022-02-06 13:40:28 -05:00
.gitignore Added simple docusaurus site 2022-02-06 13:40:28 -05:00
babel.config.js Added simple docusaurus site 2022-02-06 13:40:28 -05:00
docusaurus.config.js Added simple docusaurus site 2022-02-06 13:40:28 -05:00
package.json Added simple docusaurus site 2022-02-06 13:40:28 -05:00
README.md Added simple docusaurus site 2022-02-06 13:40:28 -05:00
sidebars.js Added simple docusaurus site 2022-02-06 13:40:28 -05:00
yarn.lock Added simple docusaurus site 2022-02-06 13:40:28 -05: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 opens 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

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.