rootiest/fish-config
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(tricks): auto-create fish-config.1 symlink on shell start
Offline docs drift reminder / remind (push) Failing after 3s
Details
Generate man page / build-manpage (push) Successful in 16s
Details

Browse Source 
The symlink from ~/.local/share/man/man1/fish-config.1 to
docs/fish-config.1 is now created automatically alongside the
existing MANPATH setup, making `man fish-config` work out of the
box on any machine after cloning. Simplified docs accordingly.
This commit is contained in:
Rootiest
2026-06-06 04:37:54 -04:00
parent b2dd199e2f
commit 4117b0ddb6
3 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -321,13 +321,13 @@ The viewer falls back through: **ov** (syntax highlight + section navigation)
Examples: `config_help keybindings` · `config_help pkg` · `config_help fish-deps` · `config_help abbreviations`
You can also read the documentation as a standard man page:
You can also read the documentation as a standard man page — the symlink and `MANPATH` are set up automatically on shell start:
```fish
man fish-config
```
This works once `~/.local/share/man` is on your `MANPATH` (added automatically by `conf.d/tricks.fish`) and `~/.local/share/man/man1/fish-config.1` is symlinked to `docs/fish-config.1`. The man page itself is auto-generated from `docs/fish-config.md` by the CI pipeline on every push to `main`.
The man page is auto-generated from `docs/fish-config.md` by the CI pipeline on every push to `main`.
> **Note:** `fish-config` (hyphen) is this configuration's man page. `fish_config` (underscore) is fish's built-in browser-based configuration tool — a completely separate command. Don't mix them up.