Merge pull request 'docs: update documentation URL to fish.rootiest.fyi' (#86) from feat/override-path-and-xdg into main
Reviewed-on: #86
This commit was merged in pull request #86.
This commit is contained in:
@@ -5,7 +5,7 @@ built around a Catppuccin Mocha aesthetic with a curated set of modern
|
|||||||
CLI tool integrations, smart shell functions, and a heavily customized
|
CLI tool integrations, smart shell functions, and a heavily customized
|
||||||
abbreviation system for keyboard-driven workflows.
|
abbreviation system for keyboard-driven workflows.
|
||||||
|
|
||||||
📖 **[Documentation site](https://fish-config.rootiest.fyi/)**
|
📖 **[Documentation site](https://fish.rootiest.fyi/)**
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ the watcher inert without uninstalling it.
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
### [📖 Documentation Site](https://fish-config.rootiest.fyi/)
|
### [📖 Documentation Site](https://fish.rootiest.fyi/)
|
||||||
|
|
||||||
A Starlight-powered site rebuilt on every push to `main`. It covers
|
A Starlight-powered site rebuilt on every push to `main`. It covers
|
||||||
configuration variables, key bindings, abbreviations, all functions, the
|
configuration variables, key bindings, abbreviations, all functions, the
|
||||||
@@ -309,7 +309,7 @@ Command shadows react immediately; bindings, prompt, and abbreviations take effe
|
|||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
The core of the [Zoxide integration](https://fish-config.rootiest.fyi/02-path-setup/) in this repository was originally adapted from the [icezyclon/zoxide.fish](https://github.com/icezyclon/zoxide.fish) plugin (MIT Licensed) and has since been heavily customized for performance and Fish 4.x compatibility.
|
The core of the [Zoxide integration](https://fish.rootiest.fyi/02-path-setup/) in this repository was originally adapted from the [icezyclon/zoxide.fish](https://github.com/icezyclon/zoxide.fish) plugin (MIT Licensed) and has since been heavily customized for performance and Fish 4.x compatibility.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -2644,7 +2644,7 @@ that matches the keyword. Lookup order: docs/fish-config.index (exact
|
|||||||
keyword aliases), then a normalized heading scan as fallback.
|
keyword aliases), then a normalized heading scan as fallback.
|
||||||
When opened with ov a sticky navigation hint is shown at the top of the
|
When opened with ov a sticky navigation hint is shown at the top of the
|
||||||
screen. Section matching is case-insensitive. Pass --html / -w to open
|
screen. Section matching is case-insensitive. Pass --html / -w to open
|
||||||
the published documentation website (https://fish-config.rootiest.fyi/)
|
the published documentation website (https://fish.rootiest.fyi/)
|
||||||
in the default browser via xdg-open \[em] deep links to a section aren\[aq]t
|
in the default browser via xdg-open \[em] deep links to a section aren\[aq]t
|
||||||
supported there, so if a keyword is given a note points you to the site\[aq]s
|
supported there, so if a keyword is given a note points you to the site\[aq]s
|
||||||
search box instead. Pass --man / -m to open the compiled man page
|
search box instead. Pass --man / -m to open the compiled man page
|
||||||
@@ -2935,7 +2935,7 @@ Notes:
|
|||||||
|
|
||||||
Example:
|
Example:
|
||||||
open-url https://git.rootiest.dev/rootiest/fish-config
|
open-url https://git.rootiest.dev/rootiest/fish-config
|
||||||
open-url -v https://fish-config.rootiest.fyi/
|
open-url -v https://fish.rootiest.fyi/
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
@@ -4404,7 +4404,7 @@ help config --html
|
|||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
.PP
|
.PP
|
||||||
Opens https://fish-config.rootiest.fyi/ in the default browser \[em] the
|
Opens https://fish.rootiest.fyi/ in the default browser \[em] the
|
||||||
Starlight-powered site built from \f[V]docs/manual/**\f[R] on every push
|
Starlight-powered site built from \f[V]docs/manual/**\f[R] on every push
|
||||||
to \f[V]main\f[R].
|
to \f[V]main\f[R].
|
||||||
It has a section sidebar and full-text search.
|
It has a section sidebar and full-text search.
|
||||||
|
|||||||
+3
-3
@@ -2086,7 +2086,7 @@ Add -i (interactive confirmation) to destructive commands:
|
|||||||
keyword aliases), then a normalized heading scan as fallback.
|
keyword aliases), then a normalized heading scan as fallback.
|
||||||
When opened with ov a sticky navigation hint is shown at the top of the
|
When opened with ov a sticky navigation hint is shown at the top of the
|
||||||
screen. Section matching is case-insensitive. Pass --html / -w to open
|
screen. Section matching is case-insensitive. Pass --html / -w to open
|
||||||
the published documentation website (https://fish-config.rootiest.fyi/)
|
the published documentation website (https://fish.rootiest.fyi/)
|
||||||
in the default browser via xdg-open — deep links to a section aren't
|
in the default browser via xdg-open — deep links to a section aren't
|
||||||
supported there, so if a keyword is given a note points you to the site's
|
supported there, so if a keyword is given a note points you to the site's
|
||||||
search box instead. Pass --man / -m to open the compiled man page
|
search box instead. Pass --man / -m to open the compiled man page
|
||||||
@@ -2350,7 +2350,7 @@ Add -i (interactive confirmation) to destructive commands:
|
|||||||
|
|
||||||
Example:
|
Example:
|
||||||
open-url https://git.rootiest.dev/rootiest/fish-config
|
open-url https://git.rootiest.dev/rootiest/fish-config
|
||||||
open-url -v https://fish-config.rootiest.fyi/
|
open-url -v https://fish.rootiest.fyi/
|
||||||
|
|
||||||
**Used by:** `repo-open`
|
**Used by:** `repo-open`
|
||||||
|
|
||||||
@@ -3365,7 +3365,7 @@ There are four ways to read this manual.
|
|||||||
|
|
||||||
help config --html
|
help config --html
|
||||||
|
|
||||||
Opens https://fish-config.rootiest.fyi/ in the default browser — the
|
Opens https://fish.rootiest.fyi/ in the default browser — the
|
||||||
Starlight-powered site built from `docs/manual/**` on every push to `main`.
|
Starlight-powered site built from `docs/manual/**` on every push to `main`.
|
||||||
It has a section sidebar and full-text search. Deep links to a specific
|
It has a section sidebar and full-text search. Deep links to a specific
|
||||||
section aren't supported from the command line; once the site opens, use
|
section aren't supported from the command line; once the site opens, use
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ There are four ways to read this manual.
|
|||||||
|
|
||||||
help config --html
|
help config --html
|
||||||
|
|
||||||
Opens https://fish-config.rootiest.fyi/ in the default browser — the
|
Opens https://fish.rootiest.fyi/ in the default browser — the
|
||||||
Starlight-powered site built from `docs/manual/**` on every push to `main`.
|
Starlight-powered site built from `docs/manual/**` on every push to `main`.
|
||||||
It has a section sidebar and full-text search. Deep links to a specific
|
It has a section sidebar and full-text search. Deep links to a specific
|
||||||
section aren't supported from the command line; once the site opens, use
|
section aren't supported from the command line; once the site opens, use
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import starlight from '@astrojs/starlight';
|
|||||||
import sidebar from './src/sidebar.json' with { type: 'json' };
|
import sidebar from './src/sidebar.json' with { type: 'json' };
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
site: 'https://fish-config.rootiest.fyi',
|
site: 'https://fish.rootiest.fyi',
|
||||||
integrations: [
|
integrations: [
|
||||||
starlight({
|
starlight({
|
||||||
title: 'Rootiest Fish Config',
|
title: 'Rootiest Fish Config',
|
||||||
|
|||||||
@@ -18,7 +18,7 @@
|
|||||||
# keyword aliases), then a normalized heading scan as fallback.
|
# keyword aliases), then a normalized heading scan as fallback.
|
||||||
# When opened with ov a sticky navigation hint is shown at the top of the
|
# When opened with ov a sticky navigation hint is shown at the top of the
|
||||||
# screen. Section matching is case-insensitive. Pass --html / -w to open
|
# screen. Section matching is case-insensitive. Pass --html / -w to open
|
||||||
# the published documentation website (https://fish-config.rootiest.fyi/)
|
# the published documentation website (https://fish.rootiest.fyi/)
|
||||||
# in the default browser via xdg-open — deep links to a section aren't
|
# in the default browser via xdg-open — deep links to a section aren't
|
||||||
# supported there, so if a keyword is given a note points you to the site's
|
# supported there, so if a keyword is given a note points you to the site's
|
||||||
# search box instead. Pass --man / -m to open the compiled man page
|
# search box instead. Pass --man / -m to open the compiled man page
|
||||||
@@ -59,7 +59,7 @@ function config-help --description 'Open the offline fish shell configuration ma
|
|||||||
set -l doc_file "$__fish_config_dir/docs/fish-config.md"
|
set -l doc_file "$__fish_config_dir/docs/fish-config.md"
|
||||||
set -l idx_file "$__fish_config_dir/docs/fish-config.index"
|
set -l idx_file "$__fish_config_dir/docs/fish-config.index"
|
||||||
set -l man_file "$__fish_config_dir/docs/fish-config.1"
|
set -l man_file "$__fish_config_dir/docs/fish-config.1"
|
||||||
set -l site_url "https://fish-config.rootiest.fyi/"
|
set -l site_url "https://fish.rootiest.fyi/"
|
||||||
|
|
||||||
# ── Extract section keyword (first non-flag argument) ────────
|
# ── Extract section keyword (first non-flag argument) ────────
|
||||||
set -l section_kw ""
|
set -l section_kw ""
|
||||||
|
|||||||
@@ -36,7 +36,7 @@
|
|||||||
#
|
#
|
||||||
# EXAMPLE
|
# EXAMPLE
|
||||||
# open-url https://git.rootiest.dev/rootiest/fish-config
|
# open-url https://git.rootiest.dev/rootiest/fish-config
|
||||||
# open-url -v https://fish-config.rootiest.fyi/
|
# open-url -v https://fish.rootiest.fyi/
|
||||||
#
|
#
|
||||||
# NOTES
|
# NOTES
|
||||||
# Typo abbreviation: url-open (expands to open-url on space/enter).
|
# Typo abbreviation: url-open (expands to open-url on space/enter).
|
||||||
|
|||||||
Reference in New Issue
Block a user