Archived

This repository has been archived on 2024-03-03. You can view files and clone it, but cannot push or open issues or pull requests.

History

Liam e8f72ea949 Some checks failed 📚 Deploy Documentation / deploy (push) Has been cancelled Details bob		2024-03-02 11:37:04 +00:00
..
docs	bob	2024-03-02 11:37:04 +00:00
src/css	bob	2024-03-02 11:37:04 +00:00
static	bob	2024-03-02 11:37:04 +00:00
.gitignore	bob	2024-03-02 11:37:04 +00:00
babel.config.js	bob	2024-03-02 11:37:04 +00:00
docusaurus.config.js	bob	2024-03-02 11:37:04 +00:00
package.json	bob	2024-03-02 11:37:04 +00:00
README.md	bob	2024-03-02 11:37:04 +00:00
sidebars.js	bob	2024-03-02 11:37:04 +00:00
yarn.lock	bob	2024-03-02 11:37:04 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn

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.

yarn build

This command generates static content in the build directory. It can then be served using any static content hosting service.

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

If you're using GitHub pages, this command is a convenient way to build and push to the gh-pages branch.