Files

T

docs(site): replace starter README and title synopsis fences

Swap the Starlight scaffold README for one describing this project's
two-source SSOT and dev/deploy workflow. Give the generated function
synopsis fence a Starlight filename title (`fish title="name.fish"`)
so it reads as a snippet of the function it documents.

2026-07-26 05:01:01 -04:00

936 B

Raw Blame History

fish-config docs site

Starlight site for the fish-config manual.

Generated, not authored

Everything under src/content/docs/ is generated — do not edit it directly, changes will be overwritten. The sources are:

docs/manual/** — prose for every section except the functions reference
functions/*.fish comment headers — the functions reference (Section 5)

Regenerate from the repo root:

python3 docs/build-manual.py --site

docs/verify-manual.py validates both sources before you build; run it first if you've touched a header or a manual page.

Development

cd docs/site
npm install
npm run dev

Deploy

Built and deployed to Cloudflare Pages by the Gitea Actions workflow on every push to main — there's no manual deploy step.

936 B Raw Blame History

fish-config docs site

Generated, not authored

Development

Deploy

936 B

Raw Blame History