Documentation Website

This website is built using Vitepress, a modern static website generator for documentation.

Setup

You must have a recent version of Node.js (14+) installed. You may use Volta, a Node version manager, to install the latest version of Node and yarn.

$ curl https://get.volta.sh | bash
$ volta install node yarn

Installation

Finally, you will need to install the Node.js dependencies for this project using yarn or another package manager:

$ yarn install

Local Development

$ yarn run dev

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 run build

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

Deployment

Our docs are deployed using Cloudflare Pages. Every commit pushed to main branch will automatically deploy to connect.minekube.com, and any pull requests opened will have a corresponding staging URL available in the pull request comments.