Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.55 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.55 KB
Raw

Kaia Docs

Welcome to the Kaia documentation repository! This repo contains the source files for the official Kaia documentation available at https://docs.kaia.io.

Developing Kaia Docs

This website is built using Docusaurus v3.

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.