JuanCSUCoder / flatboat-docs

Documentation of the Flatboat Project.

Flatboat Documentation

This website is built using Docusaurus, a modern static website generator.

Installation

bun i

Local Development

bun 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

bun run 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 bun run deploy

Not using SSH:

GIT_USER=<Your GitHub username> bun run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push it to the `gh-pages`` branch.