Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c1243ef
WIP of new Ahoy docs
Sep 26, 2024
8da12ab
WIP of some demo things
ocean Mar 19, 2025
b06eca2
Remove Docusaurus WIP
ocean Mar 26, 2025
a46897c
Basic Astro Starlight docs beginning
ocean Mar 26, 2025
2d5d5f2
Expand docs
ocean Mar 26, 2025
7c7370e
Remove unused
ocean Mar 26, 2025
0744a54
Fix broken image and missing components
ocean Mar 26, 2025
349f950
Removed spurious and missing info
ocean Mar 26, 2025
37ebc71
Remove duplicate content
ocean Mar 26, 2025
c92a62d
Split and update Yaml docs
ocean Mar 26, 2025
10ebe48
Update and split environment docs
ocean Mar 26, 2025
ba75a89
Actually remove file
ocean Mar 26, 2025
64b8725
Many documentation updates and trying out Starlight theme
ocean Apr 17, 2025
dadcc0c
Feature: add staging deployment workflow, begin Astro setup
ocean Aug 19, 2025
b4be619
Merge pull request #1 from ahoy-cli/in-progress
ocean Aug 19, 2025
c2881fb
Chore: fix Astro config
ocean Aug 19, 2025
64f731e
Merge pull request #2 from ahoy-cli/in-progress
ocean Aug 19, 2025
cff1f11
Chore: fix Astro package versions
ocean Aug 19, 2025
670a9a9
docs: Capture all the changes where we've added badges for the versio…
ocean Jun 26, 2026
6367442
chore: Switch from npm to bun, add oxlint and oxfmt
ocean Jun 27, 2026
151c337
docs: Replace YAML configuration guide with Writing Commands
ocean Jun 27, 2026
2e4a95f
docs: Improve and streamline guide and reference page content
ocean Jun 27, 2026
011677a
fix: Rewrite shell autocompletion MDX to use valid code fence structure
ocean Jun 27, 2026
89081ca
ci: Rewrite deploy workflow using bun with zizmor-compliant permissions
ocean Jun 27, 2026
3ccc557
ci: Add zizmor GitHub Actions security analysis workflow
ocean Jun 27, 2026
dd9f4ed
ci: Add dependabot for GitHub Actions and npm dependency updates
ocean Jun 27, 2026
1648733
fix: Add actions: read permission to zizmor workflow
ocean Jun 30, 2026
3641dca
Merge branch 'main' into develop
ocean Jun 30, 2026
7c1619a
fix: Run zizmor directly instead of via action to avoid SARIF upload
ocean Jun 30, 2026
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
59 changes: 59 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Deploy Documentation

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
workflow_dispatch:

concurrency:
group: "docs-${{ github.ref }}"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
with:
persist-credentials: false

- name: Setup Bun
uses: oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6 # v2
with:
bun-version: latest

- name: Setup Pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4

- name: Install dependencies
run: bun install --frozen-lockfile

- name: Build documentation
run: bun run build

- name: Upload Pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: ./dist

deploy:
if: github.event_name != 'pull_request'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
permissions:
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
23 changes: 23 additions & 0 deletions .github/workflows/zizmor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: GitHub Actions Security Analysis with zizmor 🌈

on:
push:
branches: ["main"]
pull_request:
branches: ["**"]

permissions: {}

jobs:
zizmor:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout repository
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
with:
persist-credentials: false

- name: Run zizmor 🌈
run: pip install zizmor && zizmor .
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
4 changes: 4 additions & 0 deletions .oxfmtrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"ignorePatterns": ["**/*.mdx", "**/*.yml", "**/*.yaml"]
}
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

2 changes: 0 additions & 2 deletions README.md

This file was deleted.

54 changes: 54 additions & 0 deletions astro-starlight-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Starlight Starter Kit: Basics

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```
npm create astro@latest -- --template starlight
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

## 🚀 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
```

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.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

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).
57 changes: 57 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// @ts-check
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

// https://astro.build/config
export default defineConfig({
site: "https://ahoy-cli.github.io",
integrations: [
starlight({
title: "Ahoy",
description:
"Create self-documenting CLI programs with ease, using YAML files in your source tree",
logo: {
src: "./src/assets/logo.svg",
},
customCss: ["./src/styles/custom.css"],

social: [
{
icon: "github",
href: "https://github.com/ahoy-cli/ahoy",
label: "GitHub",
},
],
sidebar: [
{
label: "Getting Started",
items: [
{ label: "Installation & Setup", slug: "guides/getting-started" },
{ label: "Next Steps", slug: "guides/next-steps" },
{
label: "Shell Autocompletion",
slug: "guides/shell-autocompletion",
},
],
},
{
label: "Guides",
items: [
{ label: "Writing Commands", slug: "guides/writing-commands" },
{ label: "Command Execution", slug: "guides/command-execution" },
{ label: "Importing & Overriding", slug: "guides/importing" },
{ label: "Environment", slug: "guides/environment" },
],
},
{
label: "Reference",
items: [
{ label: "CLI Reference", slug: "reference/cli" },
{ label: "Environment Reference", slug: "reference/environment" },
{ label: "YAML Schema", slug: "reference/yaml-schema" },
],
},
],
}),
],
});
Loading
Loading