Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: CI

on:
push:
branches: [master]
pull_request:
branches: [master]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- run: bun install --frozen-lockfile

- run: bun run build

lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: oven-sh/setup-bun@v2
with:
bun-version: latest

- run: bun install --frozen-lockfile

- run: bunx eslint .
12 changes: 12 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Copyright (C) 2023 by the gogrlx contributors

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
50 changes: 17 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,29 @@
# grlx docs

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
[![License: 0BSD](https://img.shields.io/badge/license-0BSD-blue)](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)
41 changes: 35 additions & 6 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import eslintPluginAstro from 'eslint-plugin-astro'

export default [
{ ignores: ['.astro/**', 'dist/**'] },
...eslintPluginAstro.configs['flat/recommended'],
]
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,18 @@
"@fontsource/ibm-plex-sans": "^5.2.8",
"@fontsource/ibm-plex-serif": "^5.2.7",
"@tailwindcss/vite": "^4.2.1",
"astro": "^5.17.3",
"astro": "^5.18.0",
"sharp": "^0.34.5",
"tailwindcss": "^4.2.1"
},
"devDependencies": {
"eslint": "^9.27.0",
"@typescript-eslint/parser": "^8.56.1",
"astro-eslint-parser": "^1.3.0",
"eslint": "^9.39.3",
"eslint-plugin-astro": "^1.6.0",
"prettier": "^3.8.1",
"prettier-plugin-astro": "^0.14.1",
"prettier-plugin-tailwindcss": "^0.7.2"
"prettier-plugin-tailwindcss": "^0.7.2",
"typescript": "^5.9.3"
}
}
2 changes: 1 addition & 1 deletion src/content/docs/ingredients/groups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: grlx.ingredients.group
desc: An overview of grlx.ingredients.group
description: An overview of grlx.ingredients.group
---
The group ingredient handles group operations on sprouts.
## **group.absent**
Expand Down
3 changes: 2 additions & 1 deletion src/content/docs/ingredients/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ sidebar:
---
Recipe ingredients are how we build configurations with `grlx`. They can be thought of as the building blocks for completing various file, service, or management operations. Recipes rely on dependency injection via a provider system to provide extensible backends for various tasks. This also allows users to develop [go plugins](https://pkg.go.dev/plugin) to extend ingredient providers.
:::note
The [file ingredient](/ingredients/file) already supports a few different file providers. Check them out the list of file providers [here](/ingredients/file-providers).
The [file ingredient](/ingredients/file) already supports a few different file providers. Check out the list of file providers [here](/ingredients/file-providers).
:::
Loading
Loading