stack/docs
2024-03-21 20:48:19 +08:00
..
docs removed secondary background color 2024-03-21 20:48:19 +08:00
src added documentation link to dashboard 2024-03-04 17:32:42 +08:00
static Added docs 2024-02-28 16:53:11 +01:00
.env Head tags 2024-03-08 06:23:02 +01:00
.gitignore Added docs 2024-02-28 16:53:11 +01:00
babel.config.js Added docs 2024-02-28 16:53:11 +01:00
docusaurus.config.js Head tags 2024-03-08 06:23:02 +01:00
package.json New UI system (#5) 2024-03-21 10:51:53 +01:00
pnpm-lock.yaml Added docs 2024-02-28 16:53:11 +01:00
README.md Added docs 2024-02-28 16:53:11 +01:00
sidebars.js New UI system (#5) 2024-03-21 10:51:53 +01:00

Website

This website is built using Docusaurus, 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.