Skip to content

Commit c91c6d9

Browse files
committed
docs(readme/toc): fix broken links
1 parent a29aa5a commit c91c6d9

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,34 @@ My [**Zsh**] configuration. Fast, convenient, and pretty.
66

77
<!--toc:start-->
88

9-
- [☑️ Features](#️-features)
10-
- [🫀 Core](#🫀-core)
11-
- [⚡️ Performance](#️-performance)
12-
- [🏪 Convenience](#🏪-convenience)
13-
- [🦋 Visuals](#🦋-visuals)
14-
- [🛠️ Installation](#🛠️-installation)
9+
<!--
10+
XXX: This TOC targets <a id="readme-‥"> tags instead of section headings
11+
because GitHub's markdown renderer fails to consistently include all emoji
12+
in the heading IDs that it generates. For example, it gives the “☑️ Features”
13+
section a heading ID of `☑️-features` (as expected), but it mysteriously elides
14+
the emoji when it assigns the “🫀 Core” section a heading ID of `-core`.
15+
Rather than referencing GitHub's heading IDs (which would break the links
16+
when this document is rendered by a well-behaved Markdown renderer),
17+
this TOC links to anchor tags for each of the emoji-decorated section headings.
18+
19+
TODO: Identify/track/report/fix that bug.
20+
-->
21+
22+
- [☑️ Features](#readme-features)
23+
- [🫀 Core](#readme-core)
24+
- [⚡️ Performance](#readme-performance)
25+
- [🏪 Convenience](#readme-convenience)
26+
- [🦋 Visuals](#readme-visuals)
27+
- [🛠️ Installation](#readme-installation)
1528
- [Installation Method: Using Chezmoi](#installation-method-using-chezmoi)
1629
- [Installation Method: Manual](#installation-method-manual)
1730

1831
<!--toc:end-->
1932

2033
## ☑️ Features
2134

35+
<a id="readme-core"></a>
36+
2237
### 🫀 Core
2338

2439
- Plugin manager: [**Zi**]
@@ -30,6 +45,8 @@ My [**Zsh**] configuration. Fast, convenient, and pretty.
3045
[better-maintained]: https://github.com/orgs/z-shell/discussions/138
3146
[compare Zi]: https://www.githubcompare.com/z-shell/zi+zdharma-continuum/zinit
3247

48+
<a id="readme-performance"></a>
49+
3350
### ⚡️ Performance
3451

3552
- [**Powerlevel10k Instant Prompt**] provides an instantly interactive prompt
@@ -73,6 +90,8 @@ My [**Zsh**] configuration. Fast, convenient, and pretty.
7390
[light loading]: https://wiki.zshell.dev/docs/getting_started/overview#plugin-and-snippet-loading
7491
[turbo mode]: https://wiki.zshell.dev/docs/getting_started/overview#turbo-mode-zsh--53
7592

93+
<a id="readme-convenience"></a>
94+
7695
### 🏪 Convenience
7796

7897
- Useful and sensible settings for [Zsh options] and [Zsh parameters].
@@ -220,6 +239,8 @@ My [**Zsh**] configuration. Fast, convenient, and pretty.
220239
[compare H-S-MW]: https://www.githubcompare.com/z-shell/h-s-mw+zdharma-continuum/history-search-multi-word
221240
[vi mode]: https://zsh.sourceforge.io/Guide/zshguide04.html#l78
222241

242+
<a id="readme-visuals"></a>
243+
223244
### 🦋 Visuals
224245

225246
- Prompt theme: [**Powerlevel10k**]
@@ -263,6 +284,8 @@ My [**Zsh**] configuration. Fast, convenient, and pretty.
263284
[`bat --plain --language=help`]: https://github.com/sharkdp/bat#highlighting---help-messages
264285
[compare F-Sy-H]: https://www.githubcompare.com/z-shell/f-sy-h+zdharma-continuum/fast-syntax-highlighting
265286

287+
<a id="readme-installation"></a>
288+
266289
## 🛠️ Installation
267290

268291
### Installation Method: Using Chezmoi

0 commit comments

Comments
 (0)