https://github.com/juancsucoder/flatboat-docs
Documentation of the Flatboat Project.
https://github.com/juancsucoder/flatboat-docs
Last synced: 2 months ago
JSON representation
Documentation of the Flatboat Project.
- Host: GitHub
- URL: https://github.com/juancsucoder/flatboat-docs
- Owner: JuanCSUCoder
- Created: 2024-03-12T00:42:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-30T15:59:15.000Z (about 1 year ago)
- Last Synced: 2025-01-22T17:46:10.607Z (4 months ago)
- Language: JavaScript
- Size: 2.23 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flatboat Documentation
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```bash
bun i
```
## Local Development
```bash
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
```bash
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:
```bash
USE_SSH=true bun run deploy
```
Not using SSH:
```bash
GIT_USER= 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.