chore(docs): regenerate man page, HTML docs, and wiki

This commit is contained in:
Gitea Actions
2026-06-09 03:15:49 +00:00
parent 831c7beb4d
commit 17dcc99fc2
5 changed files with 50 additions and 23 deletions
+12 -2
View File
@@ -1495,8 +1495,8 @@ echo \[dq]3 7 2 9 1\[dq] | spark
.nf .nf
\f[C] \f[C]
Synopsis: config-help [SECTION] Synopsis: config-help [SECTION]
config-help --html config-help [SECTION] --html
config-help --man config-help [SECTION] --man
config-help -h | --help config-help -h | --help
Opens the offline fish shell configuration manual. Without flags, opens Opens the offline fish shell configuration manual. Without flags, opens
@@ -1506,16 +1506,20 @@ 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 docs/html/index.html in the default browser.
If SECTION is given, opens at the matching anchor.
Detects the browser via xdg-mime x-scheme-handler/https, Detects the browser via xdg-mime x-scheme-handler/https,
then known binaries, then xdg-open as last resort. then known binaries, then xdg-open as last resort.
Respects $fish_help_browser and $BROWSER. Respects $fish_help_browser and $BROWSER.
--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.
--help / -h Print usage and navigation key reference. --help / -h Print usage and navigation key reference.
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
Also available as: help config [SECTION] [FLAGS] Also available as: help config [SECTION] [FLAGS]
\f[R] \f[R]
@@ -2066,11 +2070,14 @@ bat --language=markdown --paging=always \[ti]/.config/fish/docs/fish-config.md
.nf .nf
\f[C] \f[C]
help config --man help config --man
help config pkg --man
\f[R] \f[R]
.fi .fi
.PP .PP
Opens the compiled docs/fish-config.1 directly via man -l, bypassing the Opens the compiled docs/fish-config.1 directly via man -l, bypassing the
pager fallback chain. pager fallback chain.
If a section keyword is given, the pager opens at the nearest matching
heading.
The symlink and MANPATH are also configured automatically on shell start The symlink and MANPATH are also configured automatically on shell start
for the standard invocation: for the standard invocation:
.IP .IP
@@ -2089,10 +2096,13 @@ Do not mix them up.
.nf .nf
\f[C] \f[C]
help config --html help config --html
help config pkg --html
\f[R] \f[R]
.fi .fi
.PP .PP
Opens docs/html/index.html in the default web browser. Opens docs/html/index.html in the default web browser.
If a section keyword is given, the browser opens directly at the
matching anchor (resolved via docs/html/sitemap.json).
Browser detection queries the system\[cq]s x-scheme-handler/https MIME Browser detection queries the system\[cq]s x-scheme-handler/https MIME
entry (via xdg-mime) to find the real browser binary, then falls back entry (via xdg-mime) to find the real browser binary, then falls back
through known browser binaries (firefox, chromium, vivaldi, etc.), and through known browser binaries (firefox, chromium, vivaldi, etc.), and
+14 -10
View File
@@ -505,23 +505,27 @@ q quit</code></pre>
<h2 data-number="15.2" id="with-bat">With bat</h2> <h2 data-number="15.2" id="with-bat">With bat</h2>
<pre><code>bat --language=markdown --paging=always ~/.config/fish/docs/fish-config.md</code></pre> <pre><code>bat --language=markdown --paging=always ~/.config/fish/docs/fish-config.md</code></pre>
<h2 data-number="15.3" id="as-a-man-page">As a man page</h2> <h2 data-number="15.3" id="as-a-man-page">As a man page</h2>
<pre><code>help config --man</code></pre> <pre><code>help config --man
help config pkg --man</code></pre>
<p>Opens the compiled docs/fish-config.1 directly via man -l, bypassing <p>Opens the compiled docs/fish-config.1 directly via man -l, bypassing
the pager fallback chain. The symlink and MANPATH are also configured the pager fallback chain. If a section keyword is given, the pager opens
automatically on shell start for the standard invocation:</p> at the nearest matching heading. The symlink and MANPATH are also
configured automatically on shell start for the standard invocation:</p>
<pre><code>man fish-config</code></pre> <pre><code>man fish-config</code></pre>
<p>NOTE: fish-config (hyphen) is this config's man page. fish_config <p>NOTE: fish-config (hyphen) is this config's man page. fish_config
(underscore) is fish's built-in browser-based configuration tool — a (underscore) is fish's built-in browser-based configuration tool — a
completely separate command. Do not mix them up.</p> completely separate command. Do not mix them up.</p>
<h2 data-number="15.4" id="in-the-browser-html">In the browser <h2 data-number="15.4" id="in-the-browser-html">In the browser
(HTML)</h2> (HTML)</h2>
<pre><code>help config --html</code></pre> <pre><code>help config --html
<p>Opens docs/html/index.html in the default web browser. Browser help config pkg --html</code></pre>
detection queries the system's x-scheme-handler/https MIME entry (via <p>Opens docs/html/index.html in the default web browser. If a section
xdg-mime) to find the real browser binary, then falls back through known keyword is given, the browser opens directly at the matching anchor
browser binaries (firefox, chromium, vivaldi, etc.), and finally (resolved via docs/html/sitemap.json). Browser detection queries the
xdg-open as a last resort. Set $fish_help_browser or $BROWSER to system's x-scheme-handler/https MIME entry (via xdg-mime) to find the
override.</p> real browser binary, then falls back through known browser binaries
(firefox, chromium, vivaldi, etc.), and finally xdg-open as a last
resort. Set $fish_help_browser or $BROWSER to override.</p>
<h2 data-number="15.5" id="as-a-wiki">As a wiki</h2> <h2 data-number="15.5" id="as-a-wiki">As a wiki</h2>
<p>The generated Markdown wiki lives in docs/wiki/. index.md provides <p>The generated Markdown wiki lives in docs/wiki/. index.md provides
the project overview and a full table of contents. Each section page has the project overview and a full table of contents. Each section page has
+6 -2
View File
@@ -1005,8 +1005,8 @@ echo &quot;3 7 2 9 1&quot; | spark</code></pre>
<h2 data-number="9.14" id="514-miscellaneous">5.14 Miscellaneous</h2> <h2 data-number="9.14" id="514-miscellaneous">5.14 Miscellaneous</h2>
<h3 data-number="9.14.1" id="config-help">config-help</h3> <h3 data-number="9.14.1" id="config-help">config-help</h3>
<pre><code>Synopsis: config-help [SECTION] <pre><code>Synopsis: config-help [SECTION]
config-help --html config-help [SECTION] --html
config-help --man config-help [SECTION] --man
config-help -h | --help config-help -h | --help
Opens the offline fish shell configuration manual. Without flags, opens Opens the offline fish shell configuration manual. Without flags, opens
@@ -1016,16 +1016,20 @@ 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 docs/html/index.html in the default browser.
If SECTION is given, opens at the matching anchor.
Detects the browser via xdg-mime x-scheme-handler/https, Detects the browser via xdg-mime x-scheme-handler/https,
then known binaries, then xdg-open as last resort. then known binaries, then xdg-open as last resort.
Respects $fish_help_browser and $BROWSER. Respects $fish_help_browser and $BROWSER.
--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.
--help / -h Print usage and navigation key reference. --help / -h Print usage and navigation key reference.
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
Also available as: help config [SECTION] [FLAGS]</code></pre> Also available as: help config [SECTION] [FLAGS]</code></pre>
<h3 data-number="9.14.2" id="config-update">config-update</h3> <h3 data-number="9.14.2" id="config-update">config-update</h3>
+12 -7
View File
@@ -27,10 +27,12 @@ navigation.
## As a man page ## As a man page
help config --man help config --man
help config pkg --man
Opens the compiled docs/fish-config.1 directly via man -l, bypassing Opens the compiled docs/fish-config.1 directly via man -l, bypassing
the pager fallback chain. The symlink and MANPATH are also configured the pager fallback chain. If a section keyword is given, the pager opens
automatically on shell start for the standard invocation: at the nearest matching heading. The symlink and MANPATH are also
configured automatically on shell start for the standard invocation:
man fish-config man fish-config
@@ -41,12 +43,15 @@ a completely separate command. Do not mix them up.
## In the browser (HTML) ## In the browser (HTML)
help config --html help config --html
help config pkg --html
Opens docs/html/index.html in the default web browser. Browser detection Opens docs/html/index.html in the default web browser. If a section
queries the system's x-scheme-handler/https MIME entry (via xdg-mime) to keyword is given, the browser opens directly at the matching anchor
find the real browser binary, then falls back through known browser (resolved via docs/html/sitemap.json). Browser detection queries the
binaries (firefox, chromium, vivaldi, etc.), and finally xdg-open as a system's x-scheme-handler/https MIME entry (via xdg-mime) to find the
last resort. Set $fish_help_browser or $BROWSER to override. real browser binary, then falls back through known browser binaries
(firefox, chromium, vivaldi, etc.), and finally xdg-open as a last
resort. Set $fish_help_browser or $BROWSER to override.
## As a wiki ## As a wiki
+6 -2
View File
@@ -683,8 +683,8 @@
### config-help ### config-help
Synopsis: config-help [SECTION] Synopsis: config-help [SECTION]
config-help --html config-help [SECTION] --html
config-help --man config-help [SECTION] --man
config-help -h | --help config-help -h | --help
Opens the offline fish shell configuration manual. Without flags, opens Opens the offline fish shell configuration manual. Without flags, opens
@@ -694,16 +694,20 @@
Flags: Flags:
--html / -w Open docs/html/index.html in the default browser. --html / -w Open docs/html/index.html in the default browser.
If SECTION is given, opens at the matching anchor.
Detects the browser via xdg-mime x-scheme-handler/https, Detects the browser via xdg-mime x-scheme-handler/https,
then known binaries, then xdg-open as last resort. then known binaries, then xdg-open as last resort.
Respects $fish_help_browser and $BROWSER. Respects $fish_help_browser and $BROWSER.
--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.
--help / -h Print usage and navigation key reference. --help / -h Print usage and navigation key reference.
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
Also available as: help config [SECTION] [FLAGS] Also available as: help config [SECTION] [FLAGS]