You can interact with the lab using the published repository and GitHub Pages, but you are welcome to welcome to fork the repository and adapt it under the terms of the license.
This file describes how to configure your copy and build the web version for GitHub Pages on your own device or via GitHub Actions.
This website is built using Docusaurus 2, a modern static website generator.
Follow the directions in the Docusaurus documentation.
If you fork or clone this repository, you will need to edit the file docusaurus.config.js for successful builds.
Launch a local server and see edits to the content in the docs\ folder as you go with:
npm run start
Create a hostable version of the pages with:
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
This respository is also set up to build the site to GitHub Pages with GitHub Actions. See the "Actions" tab for the actual scripts used.
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.
-
Enable GitHub pages for the site. Configure to deploy from branch "gh-pages"
-
Edit
docusaurus.config.js
TODO
Docs are published on GitHub Pages
$ 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 into the build directory and can be served using any static contents hosting service.
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.