Skip to content

Commit 8ad530b

Browse files
committed
Updated documentation
1 parent 5bda328 commit 8ad530b

File tree

4 files changed

+36
-9
lines changed

4 files changed

+36
-9
lines changed

CHANGELOG

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
mkdocs-material-7.0.3+insiders-2.1.0 (2021-02-26)
2+
3+
* Added support for anchor tracking
4+
15
mkdocs-material-7.0.3 (2021-02-26)
26

37
* Fixed JavaScript errors in older browsers (target ES2020 -> ES2015)

docs/changelog/insiders.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ template: overrides/main.html
66

77
## Material for MkDocs Insiders
88

9+
### 2.1.0 <small>_ February 26, 2021</small>
10+
11+
- Added support for anchor tracking
12+
913
### 2.0.0 <small>_ February 24, 2021</small>
1014

1115
- Migrated Insiders to the new architecture

docs/insiders.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ The following features are currently exclusively available to sponsors:
112112

113113
<div class="mdx-columns" markdown="1">
114114

115-
- [x] [Section index pages :material-new-box:][21]
115+
- [x] [Anchor tracking :material-new-box:][24]
116+
- [x] [Section index pages][21]
116117
- [x] [Latest release tag][15]
117118
- [x] [Color palette toggle][16]
118119
- [x] [Sticky navigation tabs][20]
@@ -171,12 +172,14 @@ the public for general availability.
171172
#### $ 5,000 – Aji Panca
172173

173174
- [x] [Native Mermaid.js integration][23]
175+
- [x] [Anchor tracking][24]
174176

175177
[23]: reference/diagrams.md
178+
[24]: setup/setting-up-navigation.md#anchor-tracking
176179

177180
#### Future
178181

179-
- [ ] [Material for MkDocs Live Edit][24]
182+
- [ ] [Material for MkDocs Live Edit][25]
180183
- [ ] Improved search result summaries
181184
- [ ] List of last searches
182185
- [ ] Table of contents follows active anchor
@@ -186,7 +189,7 @@ the public for general availability.
186189
- [ ] New layouts and styles (e.g. vertical)
187190
- [ ] ... and much more ...
188191

189-
[24]: https://twitter.com/squidfunk/status/1338252230265360391
192+
[25]: https://twitter.com/squidfunk/status/1338252230265360391
190193

191194
### Goals completed
192195

@@ -232,10 +235,10 @@ implemented behind feature flags; all configuration changes are
232235
backward-compatible. This means that your users will be able to build the
233236
documentation locally with Material for MkDocs and when they push their changes,
234237
it can be built with Insiders (e.g. as part of GitHub Actions). Thus, it's
235-
recommended to [install Insiders][25] only in CI, as you don't want to expose
238+
recommended to [install Insiders][26] only in CI, as you don't want to expose
236239
your `GH_TOKEN` to users.
237240

238-
[25]: publishing-your-site.md#github-pages
241+
[26]: publishing-your-site.md#github-pages
239242

240243
### Terms
241244

@@ -244,7 +247,7 @@ commercial project. Can we use Insiders under the same terms and conditions?_
244247

245248
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
246249
Insiders_ precisely under the same terms as Material for MkDocs, which are given
247-
by the [MIT license][26]. However, we kindly ask you to respect the following
250+
by the [MIT license][27]. However, we kindly ask you to respect the following
248251
guidelines:
249252

250253
- Please __don't distribute the source code__ of Insiders. You may freely use
@@ -255,7 +258,7 @@ guidelines:
255258
- If you cancel your subscription, you're removed as a collaborator and will
256259
miss out on future updates of Insiders. However, you may __use the latest
257260
version__ that's available to you __as long as you like__. Just remember that
258-
[GitHub deletes private forks][27].
261+
[GitHub deletes private forks][28].
259262

260-
[26]: license.md
261-
[27]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
263+
[27]: license.md
264+
[28]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository

docs/setup/setting-up-navigation.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,22 @@ _Material for MkDocs is the only MkDocs theme offering this feature._
4141
[4]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/instant/index.ts
4242
[5]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
4343
44+
### Anchor tracking
45+
46+
[:octicons-file-code-24: Source][9] ·
47+
:octicons-unlock-24: Feature flag ·
48+
[:octicons-heart-fill-24:{: .mdx-heart } Insiders only][9]{: .mdx-insiders }
49+
50+
When _anchor tracking_ is enabled, the URL in the address bar is automatically
51+
updated with the active anchor as highlighted in the table of contents. Add the
52+
following lines to `mkdocs.yml`:
53+
54+
``` yaml
55+
theme:
56+
features:
57+
- navigation.tracking
58+
```
59+
4460
### Navigation tabs
4561

4662
[:octicons-file-code-24: Source][6] · :octicons-unlock-24: Feature flag

0 commit comments

Comments
 (0)