fish-config/docs/manual/00-synopsis.md at 1bfcd519b8c4ca2f1eef79ce13a28ebcd9882d15

Files

T

feat(docs): generate fish-config.md from the manual tree

Adds docs/build-manual.py (--concat) and a round-trip test in
verify-manual.py that reproduces the pre-migration fish-config.md
exactly from docs/manual/.

Fixes found by the round-trip check, applied in split-manual.py and
re-run to regenerate docs/manual/:
- NAME/SYNOPSIS/TABLE OF CONTENTS had no sidebar.order, so they sorted
  after every numbered section instead of interleaving with DESCRIPTION
  in original document order. All manual pages now get sidebar.order
  from a single position counter matching source order.
- split_h1/split_h2 used .strip() on section bodies, which also ate
  leading indentation on the first body line, corrupting the 4-space
  indented code blocks that open SYNOPSIS and TABLE OF CONTENTS.
- The source's leading pandoc metadata block (title/section/header/
  date/author) was discarded entirely by the splitter. It's now parsed
  off via manualtools.parse and stashed on index.md under a "pandoc"
  key; build-manual.py re-emits it verbatim ahead of the first heading.

2026-07-25 21:39:48 -04:00

438 B

Raw Blame History

title, manTitle, man, site, sidebar

title

manTitle

man

site

sidebar

Synopsis

SYNOPSIS

true

false

order
2

help config [SECTION]

Open this manual in the best available pager. Optionally jump to a section by keyword:

help config keybindings
help config pkg
help config abbreviations
help config logs

The help config syntax integrates with fish's built-in help command. The underlying config-help function is also available directly.

438 B Raw Blame History

438 B

Raw Blame History