chore(docs): regenerate manual and man page

This commit is contained in:
Gitea Actions
2026-07-26 04:33:41 +00:00
parent 1bfcd519b8
commit d23cbfc733
+65 -52
View File
@@ -1686,7 +1686,7 @@ yt-dlp --no-embed-thumbnail dQw4w9WgXcQ
.nf .nf
\f[C] \f[C]
Synopsis: config-help [SECTION] Synopsis: config-help [SECTION]
config-help [SECTION] --html config-help --html
config-help [SECTION] --man config-help [SECTION] --man
config-help -h | --help config-help -h | --help
@@ -1696,11 +1696,11 @@ cat). If SECTION is given, jumps to the first heading matching that
keyword (case-insensitive; checks fish-config.index aliases first). keyword (case-insensitive; checks fish-config.index aliases first).
Flags: Flags:
--html / -w Open docs/html/index.html in the default browser. --html / -w Open the published documentation website
If SECTION is given, opens at the matching anchor. (https://fish-config-docs.pages.dev/) in the default
Detects the browser via xdg-mime x-scheme-handler/https, browser via xdg-open. Deep links to a section aren\[aq]t
then known binaries, then xdg-open as last resort. supported; if SECTION is given, a note points you to the
Respects $fish_help_browser and $BROWSER. site\[aq]s search box instead.
--man / -m Open docs/fish-config.1 via man -l directly. --man / -m Open docs/fish-config.1 via man -l directly.
If SECTION is given, jumps to the nearest match. If SECTION is given, jumps to the nearest match.
--help / -h Print usage and navigation key reference. --help / -h Print usage and navigation key reference.
@@ -1708,7 +1708,6 @@ Flags:
config-help keybindings config-help keybindings
config-help pkg config-help pkg
config-help --html config-help --html
config-help pkg --html
config-help --man config-help --man
config-help pkg --man config-help pkg --man
@@ -1739,7 +1738,7 @@ Resolution order:
5. xdg-open (last resort) 5. xdg-open (last resort)
open-url https://git.rootiest.dev/rootiest/fish-config open-url https://git.rootiest.dev/rootiest/fish-config
open-url \[dq]file://$HOME/.config/fish/docs/html/index.html\[dq] open-url -v https://fish-config-docs.pages.dev/
Used internally by config-help --html. Used internally by config-help --html.
@@ -2880,36 +2879,23 @@ local.fish in turn sources secrets.fish when it exists.
.PP .PP
* * * * * * * * * *
.SH 11. VIEWING THIS MANUAL .SH 11. VIEWING THIS MANUAL
.SS With ov (recommended) .PP
There are four ways to read this manual.
.SS The documentation website
.IP .IP
.nf .nf
\f[C] \f[C]
help config help config --html
\f[R] \f[R]
.fi .fi
.PP .PP
ov renders the Markdown with syntax highlighting and section-based Opens https://fish-config-docs.pages.dev/ in the default browser \[em]
navigation. the Starlight-powered site built from \f[V]docs/manual/**\f[R] on every
.IP push to \f[V]main\f[R].
.nf It has a section sidebar and full-text search.
\f[C] Deep links to a specific section aren\[cq]t supported from the command
Space next section line; once the site opens, use its search box to jump straight to what
\[ha] previous section you need.
Alt+u toggle section list sidebar
/ search forward
n / N next / previous search match
g go to line number
j interactive jump target (line, %, or \[aq]section\[aq])
q quit
\f[R]
.fi
.SS With bat
.IP
.nf
\f[C]
bat --language=markdown --paging=always \[ti]/.config/fish/docs/fish-config.md
\f[R]
.fi
.SS As a man page .SS As a man page
.IP .IP
.nf .nf
@@ -2936,33 +2922,49 @@ NOTE: fish-config (hyphen) is this config\[cq]s man page.
fish_config (underscore) is fish\[cq]s built-in browser-based fish_config (underscore) is fish\[cq]s built-in browser-based
configuration tool \[em] a completely separate command. configuration tool \[em] a completely separate command.
Do not mix them up. Do not mix them up.
.SS In the browser (HTML) .SS In the terminal
.IP .IP
.nf .nf
\f[C] \f[C]
help config --html help config
help config pkg --html help config keybindings
\f[R] \f[R]
.fi .fi
.PP .PP
Opens docs/html/index.html in the default web browser. Without a pager available beyond the basics,
If a section keyword is given, the browser opens directly at the \f[V]help config [SECTION]\f[R] opens the Markdown manual in the best
matching anchor (resolved via docs/html/sitemap.json). available viewer, falling back through:
Browser detection queries the system\[cq]s x-scheme-handler/https MIME .IP
entry (via xdg-mime) to find the real browser binary, then falls back .nf
through known browser binaries (firefox, chromium, vivaldi, etc.), and \f[C]
finally xdg-open as a last resort. 1. ov + bat section navigation + syntax highlighting (best)
Set $fish_help_browser or $BROWSER to override. 2. ov alone section navigation, raw Markdown
.SS As a wiki 3. bat alone syntax highlighting, use / to search
4. man -l pre-compiled man page (if available)
5. less plain text with line-jump
6. cat plain output
\f[R]
.fi
.PP .PP
The generated Markdown wiki lives in docs/wiki/. With ov, the Markdown renders with syntax highlighting and section-based
index.md provides the project overview and a full table of contents. navigation:
Each section page has a navigation bar at the top linking to every other .IP
section. .nf
\f[C]
Space next section
\[ha] previous section
Alt+u toggle section list sidebar
/ search forward
n / N next / previous search match
g go to line number
j interactive jump target (line, %, or \[aq]section\[aq])
q quit
\f[R]
.fi
.PP .PP
The wiki is auto-generated from this file by the CI pipeline on every If SECTION is given, the pager opens at the first heading that matches
push to main that changes docs/fish-config.md. the keyword (case-insensitive; checks \f[V]docs/fish-config.index\f[R]
.SS Jumping to a section aliases first, then falls back to a normalized heading scan):
.IP .IP
.nf .nf
\f[C] \f[C]
@@ -2973,7 +2975,18 @@ help config logs
help config fish-deps help config fish-deps
\f[R] \f[R]
.fi .fi
.SS Reading the source directly
.PP .PP
The keyword is matched case-insensitively against section headings. \f[V]docs/manual/**\f[R] is the single source of truth this manual, the
man page, and the website are all generated from.
Numbered files and directories correspond to the numbered sections in
this manual \[em] browse them in any editor, or from a shell:
.IP
.nf
\f[C]
cd \[ti]/.config/fish/docs/manual
grep -rn \[dq]keybindings\[dq] .
\f[R]
.fi
.SH AUTHORS .SH AUTHORS
Rootiest. Rootiest.