From 17dcc99fc2b5d7a855b3b1ea8a4709ffab4d952c Mon Sep 17 00:00:00 2001 From: Gitea Actions Date: Tue, 9 Jun 2026 03:15:49 +0000 Subject: [PATCH] chore(docs): regenerate man page, HTML docs, and wiki --- docs/fish-config.1 | 14 ++++++++++++-- docs/html/15-11-viewing-this-manual.html | 24 ++++++++++++++---------- docs/html/9-5-functions-reference.html | 8 ++++++-- docs/wiki/11-viewing-this-manual.md | 19 ++++++++++++------- docs/wiki/5-functions-reference.md | 8 ++++++-- 5 files changed, 50 insertions(+), 23 deletions(-) diff --git a/docs/fish-config.1 b/docs/fish-config.1 index e60aee0..2cf673d 100644 --- a/docs/fish-config.1 +++ b/docs/fish-config.1 @@ -1495,8 +1495,8 @@ echo \[dq]3 7 2 9 1\[dq] | spark .nf \f[C] Synopsis: config-help [SECTION] - config-help --html - config-help --man + config-help [SECTION] --html + config-help [SECTION] --man config-help -h | --help Opens the offline fish shell configuration manual. Without flags, opens @@ -1506,16 +1506,20 @@ keyword (case-insensitive; checks fish-config.index aliases first). Flags: --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, then known binaries, then xdg-open as last resort. Respects $fish_help_browser and $BROWSER. --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. config-help keybindings config-help pkg config-help --html +config-help pkg --html config-help --man +config-help pkg --man Also available as: help config [SECTION] [FLAGS] \f[R] @@ -2066,11 +2070,14 @@ bat --language=markdown --paging=always \[ti]/.config/fish/docs/fish-config.md .nf \f[C] help config --man +help config pkg --man \f[R] .fi .PP Opens the compiled docs/fish-config.1 directly via man -l, bypassing the 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 for the standard invocation: .IP @@ -2089,10 +2096,13 @@ Do not mix them up. .nf \f[C] help config --html +help config pkg --html \f[R] .fi .PP 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 entry (via xdg-mime) to find the real browser binary, then falls back through known browser binaries (firefox, chromium, vivaldi, etc.), and diff --git a/docs/html/15-11-viewing-this-manual.html b/docs/html/15-11-viewing-this-manual.html index 0863b43..172af0e 100644 --- a/docs/html/15-11-viewing-this-manual.html +++ b/docs/html/15-11-viewing-this-manual.html @@ -505,23 +505,27 @@ q quit

With bat

bat --language=markdown --paging=always ~/.config/fish/docs/fish-config.md

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 -the pager fallback chain. The symlink and MANPATH are also configured -automatically on shell start for the standard invocation:

+the 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 for the standard invocation:

man fish-config

NOTE: fish-config (hyphen) is this config's man page. fish_config (underscore) is fish's built-in browser-based configuration tool — a completely separate command. Do not mix them up.

In the browser (HTML)

-
help config --html
-

Opens docs/html/index.html in the default web browser. Browser -detection queries the system's x-scheme-handler/https MIME entry (via -xdg-mime) to find the 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.

+
help config --html
+help config pkg --html
+

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's x-scheme-handler/https MIME entry (via xdg-mime) to find the +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

The generated Markdown wiki lives in docs/wiki/. index.md provides the project overview and a full table of contents. Each section page has diff --git a/docs/html/9-5-functions-reference.html b/docs/html/9-5-functions-reference.html index 93c6d7d..d0dd516 100644 --- a/docs/html/9-5-functions-reference.html +++ b/docs/html/9-5-functions-reference.html @@ -1005,8 +1005,8 @@ echo "3 7 2 9 1" | spark

5.14 Miscellaneous

config-help

Synopsis:  config-help [SECTION]
-           config-help --html
-           config-help --man
+           config-help [SECTION] --html
+           config-help [SECTION] --man
            config-help -h | --help
 
 Opens the offline fish shell configuration manual. Without flags, opens
@@ -1016,16 +1016,20 @@ keyword (case-insensitive; checks fish-config.index aliases first).
 
 Flags:
   --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,
                 then known binaries, then xdg-open as last resort.
                 Respects $fish_help_browser and $BROWSER.
   --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.
 
 config-help keybindings
 config-help pkg
 config-help --html
+config-help pkg --html
 config-help --man
+config-help pkg --man
 
 Also available as: help config [SECTION] [FLAGS]

config-update

diff --git a/docs/wiki/11-viewing-this-manual.md b/docs/wiki/11-viewing-this-manual.md index eae4b1c..cc8e6d6 100644 --- a/docs/wiki/11-viewing-this-manual.md +++ b/docs/wiki/11-viewing-this-manual.md @@ -27,10 +27,12 @@ navigation. ## As a man page help config --man + help config pkg --man Opens the compiled docs/fish-config.1 directly via man -l, bypassing -the pager fallback chain. The symlink and MANPATH are also configured -automatically on shell start for the standard invocation: +the 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 for the standard invocation: man fish-config @@ -41,12 +43,15 @@ a completely separate command. Do not mix them up. ## In the browser (HTML) help config --html + help config pkg --html -Opens docs/html/index.html in the default web browser. Browser detection -queries the system's x-scheme-handler/https MIME entry (via xdg-mime) to -find the 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. +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's x-scheme-handler/https MIME entry (via xdg-mime) to find the +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 diff --git a/docs/wiki/5-functions-reference.md b/docs/wiki/5-functions-reference.md index 0c0c974..4b6cfcc 100644 --- a/docs/wiki/5-functions-reference.md +++ b/docs/wiki/5-functions-reference.md @@ -683,8 +683,8 @@ ### config-help Synopsis: config-help [SECTION] - config-help --html - config-help --man + config-help [SECTION] --html + config-help [SECTION] --man config-help -h | --help Opens the offline fish shell configuration manual. Without flags, opens @@ -694,16 +694,20 @@ Flags: --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, then known binaries, then xdg-open as last resort. Respects $fish_help_browser and $BROWSER. --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. config-help keybindings config-help pkg config-help --html + config-help pkg --html config-help --man + config-help pkg --man Also available as: help config [SECTION] [FLAGS]