Go to file
Derrick Hammer 65dfe423be
feat: add welcome
2023-09-06 08:16:36 -04:00
docs feat: add welcome 2023-09-06 08:16:36 -04:00
static/img feat: initial version 2023-09-06 07:52:18 -04:00
README.md feat: initial version 2023-09-06 07:52:18 -04:00
babel.config.js feat: initial version 2023-09-06 07:52:18 -04:00
docusaurus.config.js feat: initial version 2023-09-06 07:52:18 -04:00
package-lock.json feat: initial version 2023-09-06 07:52:18 -04:00
package.json feat: initial version 2023-09-06 07:52:18 -04:00
sidebars.js feat: initial version 2023-09-06 07:52:18 -04:00
tsconfig.json feat: initial version 2023-09-06 07:52:18 -04:00

README.md

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.