rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Wiki Activity
436 Commits 1 Branch 0 Tags
63e71ac9ddbd80e7cda9041f09f1810bd2c5a060
Commit Graph
6 Commits
Author SHA1 Message Date
rootiest 21437d1881 feat(docs): add auto-generated Markdown wiki
Offline docs drift reminder / remind (push) Successful in 10s
Details
Generate documentation / build-docs (push) Successful in 32s
Details 
Adds docs/split-wiki.py, a Python script that splits fish-config.md
into a multi-page Markdown wiki under docs/wiki/:

- index.md: DESCRIPTION intro + full section ToC
- one file per numbered section (1-configuration-variables.md … 9-viewing-this-manual.md)
- each section page has a nav bar at the top linking to every other section

The build-docs.yml workflow now runs the script alongside pandoc so all
three formats (man page, HTML, wiki) are regenerated together from a
single source in one CI run.

README slimmed down to a pointer to the wiki; docs/fish-config.md §9
gains an "As a wiki" subsection.
 2026-06-08 16:27:35 -04:00
rootiest a9ce4b9ada ci(docs): merge man-page and html-docs workflows into build-docs 
Both workflows triggered on the same path change, installed pandoc
separately, and raced to commit — the second always failed on push
due to new commits from the first. A single job installs pandoc once,
generates both outputs, and commits them together.
 2026-06-08 15:36:31 -04:00
rootiest 9795164eda feat(docs): add dark-mode HTML styling and drop per-page ToC 
- Add docs/html-style.html with Catppuccin Latte/Mocha palette,
  auto-selected via prefers-color-scheme
- Update html-docs workflow: embed stylesheet via --include-in-header,
  remove --toc so per-page sidebar is gone (index.html remains the ToC)
- Touch docs/fish-config.md to trigger the HTML generation workflow

fix(ci): clear docs/html/ before pandoc to avoid directory-exists error

fix(docs): restore toc on index, hide it on section pages via JS, fix
full-page bg

fix(docs): fix nav alignment by grouping label+link pairs as flex units

chore(docs): regenerate offline HTML docs
 2026-06-08 11:57:04 -04:00
rootiest 8ea448adb8 ci(html-docs): add automatically generated html docs 2026-06-08 11:28:28 -04:00
rootiest b6aa81f3b1 fix(ci): replace nonexistent gitea-issue-create action with curl API call 
The `actions/gitea-issue-create@v1` action does not exist on GitHub,
causing the docs-drift workflow to fail at clone time. Replace it with
a direct call to the Gitea REST API using curl. Also corrects the label
from `documentation` to `Kind/Documentation`.
 2026-06-06 23:20:18 -04:00
rootiest 02c27c6907 feat(docs): add offline documentation, config_help viewer, and CI pipelines 
- docs/fish-config.md: curated terminal-optimized manual covering all
  public functions, keybindings, abbreviations, configuration variables,
  dependency catalog, and customization guide. Written for ov/bat/less
  readability rather than browser rendering — no callouts, no hyperlinks.
  Pandoc-compatible YAML front matter for man page compilation.

- functions/config_help.fish: viewer function with fallback chain
  ov -> bat -> man -l -> less -> cat. Accepts an optional section
  keyword to jump directly to the first matching heading.

- .gitea/workflows/man-page.yml: compiles docs/fish-config.md to
  docs/fish-config.1 via pandoc on every push to main that touches the
  source doc, then commits the result automatically.

- .gitea/workflows/docs-drift.yml: opens a reminder issue whenever
  README.md changes without a corresponding docs/fish-config.md update
  in the same push.

- README.md: documents config_help and the offline manual.
- AGENTS.md: adds Convention 10 requiring offline doc to be updated
  alongside any function, keybinding, or config change.
 2026-06-06 03:14:36 -04:00