squiggle/packages/website
2022-02-10 13:47:27 -05:00
..
blog Minor docusaurus changes 2022-02-09 10:22:51 -05:00
docs Update Future-Features.md 2022-02-10 13:47:27 -05:00
src Minor docusaurus changes 2022-02-09 10:22:51 -05:00
static Restructured codebase a little 2022-02-06 14:48:21 -05:00
.gitignore Restructured codebase a little 2022-02-06 14:48:21 -05:00
babel.config.js Restructured codebase a little 2022-02-06 14:48:21 -05:00
docusaurus.config.js Minor docusaurus changes 2022-02-09 10:22:51 -05:00
package-lock.json Add Lerna with dependencies between packages 2022-02-08 13:59:37 +11:00
package.json Restructured codebase a little 2022-02-06 14:48:21 -05:00
README.md Restructured codebase a little 2022-02-06 14:48:21 -05:00
sidebars.js Restructured codebase a little 2022-02-06 14:48:21 -05:00
yarn.lock Minor updates to website config 2022-02-09 10:03:07 -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.