Skip to content

Commit fc5f65a

Browse files
committed
Updated documentation
1 parent 79c56f5 commit fc5f65a

12 files changed

+141
-59
lines changed

docs/changelog/index.md

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

77
## Material for MkDocs
88

9+
### 8.0.0 <small>_ November 28, 2021</small> { id="8.0.0" }
10+
11+
_This is a release with several template changes, many of which were previously
12+
deprecated, which might break your site if you customized the theme. Please see
13+
the [upgrade guide] for instructions._
14+
15+
- Added support for code annotations
16+
- Added support for anchor tracking
17+
- Added support for version warning
18+
- Added `copyright` partial for easier override
19+
- Removed deprecated content tabs legacy implementation
20+
- Removed deprecated `seealso` admonition type
21+
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
22+
- Removed deprecated prebuilt search index support
23+
- Removed deprecated web app manifest
24+
- Removed `extracopyright` variable
25+
- Removed Disqus integation in favor of overrides
26+
- Switched to `:is()` selectors for simple selector lists
27+
- Switched autoprefixer from `last 4 years` to `last 2 years`
28+
- Improved CSS overall to match modern standards
29+
- Improved CSS variable semantics for fonts
30+
- Improved extensibility by restructuring partials
31+
- Improved handling of `details` when printing
32+
- Improved keyboard navigation for footnotes
33+
- Fixed #3214: Search highlighting breaks site when empty
34+
35+
[upgrade guide]: ../upgrade.md##upgrading-from-7x-to-8x
36+
937
### 7.3.6 <small>_ October 30, 2021</small> { id="7.3.6" }
1038

1139
- Added support for adding titles to code blocks
@@ -39,7 +67,7 @@ template: overrides/main.html
3967
- Deprecated prebuilding of search index
4068
- Improved graceful handling of broken search for `file://`
4169
- Added minimum Jinja version to list of requirements
42-
- Fixed #3071: section index pages render empty directories
70+
- Fixed #3071: Section index pages render empty directories
4371
- Fixed margin issues when using navigation tabs (7.3.1 regression)
4472
- Fixed search placeholder sometimes being shown too early
4573

docs/getting-started.md

-10
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,6 @@ If not, we recommended using [`docker`][docker].
1616

1717
## Installation
1818

19-
!!! danger "8.0.0 Beta 2 is out!"
20-
21-
Help test the latest version of Material for MkDocs, introducing many new
22-
features and improvements like [code annotations], [anchor tracking] and
23-
[version warnings]. See #3219 for installation and upgrade instructions.
24-
25-
[code annotations]: reference/code-blocks.md#code-annotations
26-
[anchor tracking]: setup/setting-up-navigation.md#anchor-tracking
27-
[version warnings]: setup/setting-up-versioning.md#version-warning
28-
2919
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
3020

3121
Material for MkDocs can be installed with `pip`:

docs/reference/code-blocks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ See additional configuration options:
4343
4444
### Code annotations
4545
46-
[:octicons-tag-24: 8.0.0b1][Code annotations support] ·
46+
[:octicons-tag-24: 8.0.0][Code annotations support] ·
4747
:octicons-unlock-24: Feature flag ·
4848
:octicons-beaker-24: Experimental
4949
@@ -77,7 +77,7 @@ theme:
7777
Note that the language shortcode which has to come first must now also be
7878
prefixed by a `.`.
7979

80-
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
80+
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
8181
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
8282

8383
## Usage

docs/setup/setting-up-the-footer.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -140,11 +140,25 @@ extra:
140140

141141
## Customization
142142

143-
### Custom icons
143+
### Custom copyright
144144

145-
The social links feature uses the standard [icon integration] of Material for
146-
MkDocs. If you want to use custom icons, follow the guide explaining how to
147-
add [additional icons].
145+
[:octicons-tag-24: 8.0.0][Custom copyright support] ·
146+
:octicons-file-symlink-file-24: Customization
148147

149-
[icon integration]: extensions/python-markdown-extensions.md#emoji
150-
[additional icons]: changing-the-logo-and-icons.md#additional-icons
148+
In order to customize and override the [copyright notice], [extend the theme]
149+
and [override the `copyright` block][overriding blocks], which is normally set
150+
to the `copyright` property set in `mkdocs.yml`:
151+
152+
``` html
153+
{% extends "base.html" %}
154+
155+
{% block copyright %}
156+
<!-- Add copyright here, including arbitrary HTML -->
157+
{% endblock %}
158+
```
159+
160+
[Custom copyright support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
161+
[copyright notice]: #copyright-notice
162+
[generator notice]: #generator-notice
163+
[extend the theme]: ../customization.md#extending-the-theme
164+
[overriding blocks]: ../customization.md#overriding-blocks

docs/upgrade.md

+50
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,56 @@ Show the currently installed version with:
1616
pip show mkdocs-material
1717
```
1818

19+
## Upgrading from 7.x to 8.x
20+
21+
### What's new?
22+
23+
- Added support for code annotations
24+
- Added support for anchor tracking
25+
- Added support for version warning
26+
- Added `copyright` partial for easier override
27+
- Removed deprecated content tabs legacy implementation
28+
- Removed deprecated `seealso` admonition type
29+
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
30+
- Removed deprecated prebuilt search index support
31+
- Removed deprecated web app manifest
32+
- Removed `extracopyright` variable
33+
- Removed Disqus integation in favor of overrides
34+
- Switched to `:is()` selectors for simple selector lists
35+
- Switched autoprefixer from `last 4 years` to `last 2 years`
36+
- Improved CSS overall to match modern standards
37+
- Improved CSS variable semantics for fonts
38+
- Improved extensibility by restructuring partials
39+
- Improved handling of `details` when printing
40+
- Improved keyboard navigation for footnotes
41+
- Fixed #3214: Search highlighting breaks site when empty
42+
43+
### Changes to `mkdocs.yml`
44+
45+
#### `pymdownx.tabbed`
46+
47+
Support for the legacy style of the [Tabbed] extension was dropped in favor
48+
of the new, alternate implementation which has [better behavior on mobile
49+
viewports]:
50+
51+
=== "8.x"
52+
53+
``` yaml
54+
markdown_extensions:
55+
- pymdownx.tabbed:
56+
alternate_style: true
57+
```
58+
59+
=== "7.x"
60+
61+
``` yaml
62+
markdown_extensions:
63+
- pymdownx.tabbed
64+
```
65+
66+
[Tabbed]: setup/extensions/python-markdown-extensions.md#tabbed
67+
[better behavior on mobile viewports]: https://twitter.com/squidfunk/status/1424740370596958214
68+
1969
## Upgrading from 6.x to 7.x
2070

2171
### What's new?

material/assets/javascripts/bundle.0cf2fc9f.min.js

-29
This file was deleted.

material/assets/javascripts/bundle.c4fbc467.min.js

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

material/assets/javascripts/bundle.0cf2fc9f.min.js.map renamed to material/assets/javascripts/bundle.c4fbc467.min.js.map

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

material/assets/javascripts/workers/search.4b3933ee.min.js renamed to material/assets/javascripts/workers/search.01824240.min.js

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

material/assets/javascripts/workers/search.4b3933ee.min.js.map renamed to material/assets/javascripts/workers/search.01824240.min.js.map

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

material/base.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@
184184
"base": base_url,
185185
"features": features,
186186
"translations": {},
187-
"search": "assets/javascripts/workers/search.4b3933ee.min.js" | url
187+
"search": "assets/javascripts/workers/search.01824240.min.js" | url
188188
} -%}
189189
{%- if config.extra.version -%}
190190
{%- set _ = app.update({ "version": config.extra.version }) -%}
@@ -213,7 +213,7 @@
213213
</script>
214214
{% endblock %}
215215
{% block scripts %}
216-
<script src="{{ 'assets/javascripts/bundle.0cf2fc9f.min.js' | url }}"></script>
216+
<script src="{{ 'assets/javascripts/bundle.c4fbc467.min.js' | url }}"></script>
217217
{% for path in config["extra_javascript"] %}
218218
<script src="{{ path | url }}"></script>
219219
{% endfor %}

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ theme:
6060
- navigation.tabs
6161
# - navigation.tabs.sticky
6262
- navigation.top
63-
- navigation.tracking
63+
# - navigation.tracking
6464
- search.highlight
6565
- search.share
6666
- search.suggest

0 commit comments

Comments
 (0)