Skip to content

Commit ba1f021

Browse files
committed
Prepare 7.3.0 release
1 parent 9d8ebcd commit ba1f021

File tree

8 files changed

+79
-67
lines changed

8 files changed

+79
-67
lines changed

Diff for: CHANGELOG

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
mkdocs-material-7.3.0 (2021-09-23)
2+
3+
* Added support for sticky navigation tabs
4+
* Added support for section index pages
5+
* Added support for removing generator notice
6+
17
mkdocs-material-7.2.8 (2021-09-20)
28

39
* Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression)

Diff for: docs/changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ template: overrides/main.html
66

77
## Material for MkDocs
88

9+
### 7.3.0 <small>_ September 23, 2021</small>
10+
11+
- Added support for sticky navigation tabs
12+
- Added support for section index pages
13+
- Added support for removing generator notice
14+
915
### 7.2.8 <small>_ September 20, 2021</small>
1016

1117
- Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression)

Diff for: docs/insiders/index.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,7 @@ The following features are currently exclusively available to sponsors:
151151
- [x] [Custom admonition icons][31]
152152
- [x] [Code block annotations][25]
153153
- [x] [Anchor tracking ][24]
154-
- [x] [Section index pages][22]
155-
- [x] [Sticky navigation tabs][21]
156154
- [x] [Mermaid.js integration][27]
157-
- [x] [Remove generator notice][23]
158155

159156
</div>
160157

@@ -172,16 +169,6 @@ Following is a list of funding goals. When a funding goal is hit, the features
172169
that are tied to it are merged back into Material for MkDocs and released to
173170
the public for general availability.
174171

175-
#### $ 3,000 – Caribbean Red
176-
177-
- [x] [Sticky navigation tabs][21]
178-
- [x] [Section index pages][22]
179-
- [x] [Remove generator notice][23]
180-
181-
[21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs
182-
[22]: ../setup/setting-up-navigation.md#section-index-pages
183-
[23]: ../setup/setting-up-the-footer.md#remove-generator
184-
185172
#### $ 4,000 – Ghost Pepper
186173

187174
- [x] [Anchor tracking][24]
@@ -242,6 +229,16 @@ the public for general availability.
242229

243230
### Goals completed
244231

232+
#### $ 3,000 – Caribbean Red
233+
234+
- [x] [Sticky navigation tabs][21]
235+
- [x] [Section index pages][22]
236+
- [x] [Remove generator notice][23]
237+
238+
[21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs
239+
[22]: ../setup/setting-up-navigation.md#section-index-pages
240+
[23]: ../setup/setting-up-the-footer.md#remove-generator
241+
245242
#### $ 2,500 – Biquinho Vermelho
246243

247244
- [x] [Search suggestions][18]

Diff for: docs/setup/setting-up-navigation.md

+41-49
Original file line numberDiff line numberDiff line change
@@ -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
5050
When _anchor tracking_ is enabled, the URL in the address bar is automatically
5151
updated 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

6466
When _tabs_ are enabled, top-level sections are rendered in a menu layer below
6567
the 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

102103
When _sticky tabs_ are enabled, navigation tabs will lock below the header and
103104
always 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

130131
When _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

151152
Both feature flags, _tabs_ and _sections_, can be combined with each other. If
152153
both feature flags are enabled, sections are rendered for level 2 navigation
153154
items.
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

160161
When _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

187187
When _section index pages_ are enabled, documents can be directly attached to
188188
sections, 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

205205
In 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

238231
A _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

Diff for: docs/setup/setting-up-the-footer.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,7 @@ copyright: Copyright &copy; 2016 - 2020 Martin Donath
105105

106106
### Remove generator
107107

108-
[:octicons-file-code-24: Source][4] ·
109-
[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][4]{ .mdx-insiders }
108+
[:octicons-file-code-24: Source][3]
110109

111110
The footer displays a _Made with Material for MkDocs_ notice to denote how
112111
the site was generated. The notice can be removed with the following setting
@@ -117,6 +116,18 @@ extra:
117116
generator: false
118117
```
119118

119+
!!! info "Please read this before removing the generator notice"
120+
121+
The subtle __Made with Material for MkDocs__ hint in the footer is one of
122+
the reasons why this project is so popular, as it tells the user how the
123+
site is generated, helping new users to discover this project. Before
124+
removing it, please consider that you're enjoying the benefits of
125+
@squidfunk's work for free, as this project is Open Source and has a
126+
permissive license. Thousands of hours went into this project, most of them
127+
without any financial return. Thus, if you remove this notice, please
128+
consider [sponsoring][4] the project. __Thank you__
129+
:octicons-heart-fill-24:{ .mdx-heart .mdx-insiders }
130+
120131
[4]: ../insiders/index.md
121132

122133
## Customization

Diff for: material/base.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<link rel="canonical" href="{{ page.canonical_url }}">
2828
{% endif %}
2929
<link rel="icon" href="{{ config.theme.favicon | url }}">
30-
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-7.2.8">
30+
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-7.3.0">
3131
{% endblock %}
3232
{% block htmltitle %}
3333
{% if page and page.meta and page.meta.title %}

Diff for: package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mkdocs-material",
3-
"version": "7.2.8",
3+
"version": "7.3.0",
44
"description": "A Material Design theme for MkDocs",
55
"keywords": [
66
"mkdocs",

0 commit comments

Comments
 (0)