HAMi Docs & Website

This repo contains the source code of HAMi website and all of the docs for HAMi. It's built by Docusaurus 3, a modern static website generator.

Welcome to join us and you are more than appreciated to contribute!

Website Preview

Installation

npm install

Local Development

npm run start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true 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.