mirror of
https://github.com/gogrlx/docs.grlx.dev.git
synced 2026-04-02 03:08:53 -07:00
docs: add license, CI, fix content quality, document rcd provider (#38)
- Add 0BSD LICENSE (matches gogrlx/grlx)
- Add GitHub Actions CI workflow (build + eslint)
- Fix eslint config: add ignores for .astro/dist, add typescript parser deps
- Update README: replace npm boilerplate with bun commands, add badges
- Document rc.d (BSD) service provider alongside systemd
- Update service ingredient to reference provider interface instead of claiming systemd-only
- Fix frontmatter: desc -> description in groups.md and user.md
- Close unclosed :::note directive in ingredients overview
- Fix typo in ingredients overview ('Check them out the list' -> 'Check out the list')
- Update astro 5.17.3 -> 5.18.0
This commit is contained in:
50
README.md
50
README.md
@@ -1,45 +1,29 @@
|
||||
# grlx docs
|
||||
|
||||
[](https://starlight.astro.build)
|
||||
[](LICENSE)
|
||||
|
||||
Documentation site for [grlx](https://github.com/gogrlx/grlx) — effective fleet configuration management.
|
||||
|
||||
## 🚀 Project Structure
|
||||
Live at **[docs.grlx.dev](https://docs.grlx.dev)**
|
||||
|
||||
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||
## Development
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
All commands are run from the root of the project:
|
||||
|
||||
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.
|
||||
| Command | Action |
|
||||
| :--------------- | :------------------------------------------ |
|
||||
| `bun install` | Install dependencies |
|
||||
| `bun run dev` | Start local dev server at `localhost:4321` |
|
||||
| `bun run build` | Build production site to `./dist/` |
|
||||
| `bun run preview`| Preview the build locally before deploying |
|
||||
|
||||
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||
## Stack
|
||||
|
||||
Static assets, like favicons, can be placed in the `public/` directory.
|
||||
- [Astro](https://astro.build) + [Starlight](https://starlight.astro.build)
|
||||
- [Tailwind CSS v4](https://tailwindcss.com)
|
||||
- [Pagefind](https://pagefind.app) for search (built-in via Starlight)
|
||||
|
||||
## 🧞 Commands
|
||||
## License
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
| 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 [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
||||
[0BSD](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user