@@ -43,9 +43,9 @@ _Material for MkDocs is the only MkDocs theme offering this feature._
4343
4444### Anchor tracking
4545
46- [:octicons-file-code-24: Source][9 ] ·
46+ [:octicons-file-code-24: Source][6 ] ·
4747:octicons-unlock-24: Feature flag ·
48- [:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9 ]{ .mdx-insiders }
48+ [:octicons-heart-fill-24:{ .mdx-heart } Insiders only][6 ]{ .mdx-insiders }
4949
5050When _anchor tracking_ is enabled, the URL in the address bar is automatically
5151updated with the active anchor as highlighted in the table of contents. Add the
@@ -57,9 +57,11 @@ theme:
5757 - navigation.tracking
5858` ` `
5959
60+ [6] : ../insiders/index.md
61+
6062# ## Navigation tabs
6163
62- [:octicons-file-code-24 : Source][6 ] · :octicons-unlock-24: Feature flag
64+ [:octicons-file-code-24 : Source][7 ] · :octicons-unlock-24: Feature flag
6365
6466When _tabs_ are enabled, top-level sections are rendered in a menu layer below
6567the header for viewports above `1220px`, but remain as-is on mobile.[^1] Add
@@ -82,22 +84,21 @@ theme:
8284
8385=== "With tabs"
8486
85- [![With tabs][7 ]][7 ]
87+ [![With tabs][8 ]][8 ]
8688
8789=== "Without tabs"
8890
89- [![Without tabs][8 ]][8 ]
91+ [![Without tabs][9 ]][9 ]
9092
91- [6 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/tabs.html
92- [7 ] : ../assets/screenshots/navigation-tabs.png
93- [8 ] : ../assets/screenshots/navigation.png
93+ [7 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/tabs.html
94+ [8 ] : ../assets/screenshots/navigation-tabs.png
95+ [9 ] : ../assets/screenshots/navigation.png
9496
9597# ### Sticky navigation tabs
9698
97- [:octicons-file-code-24 : Source][9 ] ·
99+ [:octicons-file-code-24 : Source][10 ] ·
98100:octicons-unlock-24 : Feature flag ·
99- :octicons-beaker-24 : Experimental ·
100- [:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders }
101+ :octicons-beaker-24 : Experimental
101102
102103When _sticky tabs_ are enabled, navigation tabs will lock below the header and
103104always remain visible when scrolling down. Just add the following two feature
@@ -112,19 +113,19 @@ theme:
112113
113114=== "With sticky tabs"
114115
115- [![With sticky tabs][10 ]][10 ]
116+ [![With sticky tabs][11 ]][11 ]
116117
117118=== "Without sticky tabs"
118119
119- [![Without sticky tabs][11 ]][11 ]
120+ [![Without sticky tabs][12 ]][12 ]
120121
121- [9 ] : ../insiders/index.md
122- [10 ] : ../assets/screenshots/navigation-tabs-sticky.png
123- [11 ] : ../assets/screenshots/navigation-tabs-collapsed.png
122+ [10 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/header.html
123+ [11 ] : ../assets/screenshots/navigation-tabs-sticky.png
124+ [12 ] : ../assets/screenshots/navigation-tabs-collapsed.png
124125
125126# ## Navigation sections
126127
127- [:octicons-file-code-24 : Source][12 ] ·
128+ [:octicons-file-code-24 : Source][13 ] ·
128129:octicons-unlock-24 : Feature flag
129130
130131When _sections_ are enabled, top-level sections are rendered as groups in the
@@ -139,22 +140,22 @@ theme:
139140
140141=== "With sections"
141142
142- [![With sections][13 ]][13 ]
143+ [![With sections][14 ]][14 ]
143144
144145=== "Without sections"
145146
146- [![Without sections][8 ]][8 ]
147+ [![Without sections][9 ]][9 ]
147148
148- [12 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html
149- [13 ] : ../assets/screenshots/navigation-sections.png
149+ [13 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html
150+ [14 ] : ../assets/screenshots/navigation-sections.png
150151
151152Both feature flags, _tabs_ and _sections_, can be combined with each other. If
152153both feature flags are enabled, sections are rendered for level 2 navigation
153154items.
154155
155156# ## Navigation expansion
156157
157- [:octicons-file-code-24 : Source][12 ] ·
158+ [:octicons-file-code-24 : Source][13 ] ·
158159:octicons-unlock-24 : Feature flag
159160
160161When _expansion_ is enabled, the left sidebar will expand all collapsible
@@ -169,20 +170,19 @@ theme:
169170
170171=== "With expansion"
171172
172- [![With expansion][14 ]][14 ]
173+ [![With expansion][15 ]][15 ]
173174
174175=== "Without expansion"
175176
176- [![Without expansion][8 ]][8 ]
177+ [![Without expansion][9 ]][9 ]
177178
178- [14 ] : ../assets/screenshots/navigation-expand.png
179+ [15 ] : ../assets/screenshots/navigation-expand.png
179180
180181# ## Section index pages
181182
182- [:octicons-file-code-24 : Source][9 ] ·
183+ [:octicons-file-code-24 : Source][16 ] ·
183184:octicons-unlock-24 : Feature flag ·
184- :octicons-beaker-24 : Experimental ·
185- [:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders }
185+ :octicons-beaker-24 : Experimental
186186
187187When _section index pages_ are enabled, documents can be directly attached to
188188sections, which is particularly useful for providing overview pages. Add the
@@ -196,11 +196,11 @@ theme:
196196
197197=== "With section index pages"
198198
199- [![With expansion][15 ]][15 ]
199+ [![With expansion][17 ]][17 ]
200200
201201=== "Without section index pages"
202202
203- [![Without expansion][16 ]][16 ]
203+ [![Without expansion][18 ]][18 ]
204204
205205In order to link a page to a section, create a new document with the name
206206` index.md` in the respective folder, and add it to the beginning of your
@@ -216,23 +216,16 @@ nav:
216216` ` `
217217
218218_This feature flag can be combined with all other feature flags, e.g. [tabs][1]
219- and [sections][2], except for table of contents [navigation integration][17].
220- Note that it doesn't rely on third-party plugins[^2]._
221-
222- [^2] :
223- If you don't want to use the native integration, the
224- [mkdocs-section-index][18] plugin might be an alternative. However, note
225- that this plugin may not be compatible with all navigation-related features
226- offered by Material for MkDocs.
219+ and [sections][2], except for table of contents [navigation integration][19]._
227220
228- [15 ] : ../assets/screenshots/navigation-index-on.png
229- [16 ] : ../assets/screenshots/navigation-index-off .png
230- [17 ] : # navitation-intergation
231- [18 ] : https://github.com/oprypin/mkdocs-section-index
221+ [16 ] : https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html
222+ [17 ] : ../assets/screenshots/navigation-index-on .png
223+ [18 ] : ../assets/screenshots/navigation-index-off.png
224+ [19 ] : # navigation-integration
232225
233226# ## Back-to-top button
234227
235- [:octicons-file-code-24 : Source][19 ] ·
228+ [:octicons-file-code-24 : Source][20 ] ·
236229:octicons-unlock-24 : Feature flag
237230
238231A _back-to-top button_ can be shown when the user, after scrolling down, starts
@@ -245,11 +238,10 @@ theme:
245238 - navigation.top
246239` ` `
247240
248- [![back-to-top button][20 ]][20 ]
241+ [![back-to-top button][21 ]][21 ]
249242
250- [19] : https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_top.scss
251- [20] : ../assets/screenshots/back-to-top.png
252- [21] : https://squidfunk.github.io/mkdocs-material-insiders/setup/setting-up-navigation/#back-to-top-button
243+ [20] : https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_top.scss
244+ [21] : ../assets/screenshots/back-to-top.png
253245
254246# ## Table of contents
255247
@@ -287,7 +279,7 @@ customize its appearance:
287279: :octicons-milestone-24 : Default: `headerid.slugify` – This option allows for
288280 customization of the slug function. For some languages, the default may not
289281 produce good and readable identifiers – consider using another slug function
290- like for example those from [Python Markdown Extensions][24 ] :
282+ like for example those from [Python Markdown Extensions][25 ] :
291283
292284 === "Unicode"
293285
@@ -358,7 +350,7 @@ theme:
358350
359351=== "Separate table of contents"
360352
361- [![Separate table of contents][7 ]][7 ]
353+ [![Separate table of contents][8 ]][8 ]
362354
363355 [26] : https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_nav.scss
364356 [27] : ../assets/screenshots/toc-integrate.png
0 commit comments