docs: add README, CONTRIBUTING, LICENSE (CC BY 4.0)

This commit is contained in:
2026-05-17 10:25:30 -07:00
parent d552e6ca57
commit 351f1e1431
3 changed files with 493 additions and 37 deletions

View File

@@ -1,49 +1,33 @@
# Starlight Starter Kit: Basics
# kb.anhonesthost.com
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
The An Honest Host knowledge base — customer documentation for WHP (our hosting platform) and related services.
```
npm create astro@latest -- --template starlight
Live at: **https://kb.anhonesthost.com**
## Run locally
Requires Node 20+ (we test on 22).
```bash
npm install
npm run dev
# open http://localhost:4321
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
To expose the dev server on a different host/port (useful inside containers):
## 🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ └── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```bash
npm run dev -- --host 0.0.0.0 --port 8080
```
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
## Adding or editing a doc
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
See [CONTRIBUTING.md](./CONTRIBUTING.md) — it covers the page template, where files live, and how PRs are reviewed.
Static assets, like favicons, can be placed in the `public/` directory.
## How it deploys
## 🧞 Commands
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.
All commands are run from the root of the project, from a terminal:
## Licence
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Check out [Starlights docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
Content: [CC BY 4.0](./LICENSE). Build config and scripts: MIT (see source headers if any).