2026-05-17 10:25:30 -07:00
|
|
|
# kb.anhonesthost.com
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
The An Honest Host knowledge base — customer documentation for WHP (our hosting platform) and related services.
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
Live at: **https://kb.anhonesthost.com**
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
## Run locally
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
Requires Node 20+ (we test on 22).
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
```bash
|
|
|
|
|
npm install
|
|
|
|
|
npm run dev
|
|
|
|
|
# open http://localhost:4321
|
2026-05-17 10:24:47 -07:00
|
|
|
```
|
|
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
To expose the dev server on a different host/port (useful inside containers):
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
```bash
|
|
|
|
|
npm run dev -- --host 0.0.0.0 --port 8080
|
|
|
|
|
```
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
## Adding or editing a doc
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md) — it covers the page template, where files live, and how PRs are reviewed.
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
## How it deploys
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
Push to `main` triggers a Gitea Actions workflow that builds the site and uploads it via SFTP to the production WHP site. No manual deploy step.
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
## Licence
|
2026-05-17 10:24:47 -07:00
|
|
|
|
2026-05-17 10:25:30 -07:00
|
|
|
Content: [CC BY 4.0](./LICENSE). Build config and scripts: MIT (see source headers if any).
|