mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Updated documentation
This commit is contained in:
parent
79c56f58c4
commit
fc5f65a312
@ -6,6 +6,34 @@ template: overrides/main.html
|
|||||||
|
|
||||||
## Material for MkDocs
|
## Material for MkDocs
|
||||||
|
|
||||||
|
### 8.0.0 <small>_ November 28, 2021</small> { id="8.0.0" }
|
||||||
|
|
||||||
|
_This is a release with several template changes, many of which were previously
|
||||||
|
deprecated, which might break your site if you customized the theme. Please see
|
||||||
|
the [upgrade guide] for instructions._
|
||||||
|
|
||||||
|
- Added support for code annotations
|
||||||
|
- Added support for anchor tracking
|
||||||
|
- Added support for version warning
|
||||||
|
- Added `copyright` partial for easier override
|
||||||
|
- Removed deprecated content tabs legacy implementation
|
||||||
|
- Removed deprecated `seealso` admonition type
|
||||||
|
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
||||||
|
- Removed deprecated prebuilt search index support
|
||||||
|
- Removed deprecated web app manifest
|
||||||
|
- Removed `extracopyright` variable
|
||||||
|
- Removed Disqus integation in favor of overrides
|
||||||
|
- Switched to `:is()` selectors for simple selector lists
|
||||||
|
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
||||||
|
- Improved CSS overall to match modern standards
|
||||||
|
- Improved CSS variable semantics for fonts
|
||||||
|
- Improved extensibility by restructuring partials
|
||||||
|
- Improved handling of `details` when printing
|
||||||
|
- Improved keyboard navigation for footnotes
|
||||||
|
- Fixed #3214: Search highlighting breaks site when empty
|
||||||
|
|
||||||
|
[upgrade guide]: ../upgrade.md##upgrading-from-7x-to-8x
|
||||||
|
|
||||||
### 7.3.6 <small>_ October 30, 2021</small> { id="7.3.6" }
|
### 7.3.6 <small>_ October 30, 2021</small> { id="7.3.6" }
|
||||||
|
|
||||||
- Added support for adding titles to code blocks
|
- Added support for adding titles to code blocks
|
||||||
@ -39,7 +67,7 @@ template: overrides/main.html
|
|||||||
- Deprecated prebuilding of search index
|
- Deprecated prebuilding of search index
|
||||||
- Improved graceful handling of broken search for `file://`
|
- Improved graceful handling of broken search for `file://`
|
||||||
- Added minimum Jinja version to list of requirements
|
- Added minimum Jinja version to list of requirements
|
||||||
- Fixed #3071: section index pages render empty directories
|
- Fixed #3071: Section index pages render empty directories
|
||||||
- Fixed margin issues when using navigation tabs (7.3.1 regression)
|
- Fixed margin issues when using navigation tabs (7.3.1 regression)
|
||||||
- Fixed search placeholder sometimes being shown too early
|
- Fixed search placeholder sometimes being shown too early
|
||||||
|
|
||||||
|
@ -16,16 +16,6 @@ If not, we recommended using [`docker`][docker].
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
!!! danger "8.0.0 Beta 2 is out!"
|
|
||||||
|
|
||||||
Help test the latest version of Material for MkDocs, introducing many new
|
|
||||||
features and improvements like [code annotations], [anchor tracking] and
|
|
||||||
[version warnings]. See #3219 for installation and upgrade instructions.
|
|
||||||
|
|
||||||
[code annotations]: reference/code-blocks.md#code-annotations
|
|
||||||
[anchor tracking]: setup/setting-up-navigation.md#anchor-tracking
|
|
||||||
[version warnings]: setup/setting-up-versioning.md#version-warning
|
|
||||||
|
|
||||||
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
|
### with pip <small>recommended</small> { #with-pip data-toc-label="with pip" }
|
||||||
|
|
||||||
Material for MkDocs can be installed with `pip`:
|
Material for MkDocs can be installed with `pip`:
|
||||||
|
@ -43,7 +43,7 @@ See additional configuration options:
|
|||||||
|
|
||||||
### Code annotations
|
### Code annotations
|
||||||
|
|
||||||
[:octicons-tag-24: 8.0.0b1][Code annotations support] ·
|
[:octicons-tag-24: 8.0.0][Code annotations support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -77,7 +77,7 @@ theme:
|
|||||||
Note that the language shortcode which has to come first must now also be
|
Note that the language shortcode which has to come first must now also be
|
||||||
prefixed by a `.`.
|
prefixed by a `.`.
|
||||||
|
|
||||||
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
|
[Code annotations support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
||||||
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
|
[Attribute Lists]: ../setup/extensions/python-markdown.md#attribute-lists
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -140,11 +140,25 @@ extra:
|
|||||||
|
|
||||||
## Customization
|
## Customization
|
||||||
|
|
||||||
### Custom icons
|
### Custom copyright
|
||||||
|
|
||||||
The social links feature uses the standard [icon integration] of Material for
|
[:octicons-tag-24: 8.0.0][Custom copyright support] ·
|
||||||
MkDocs. If you want to use custom icons, follow the guide explaining how to
|
:octicons-file-symlink-file-24: Customization
|
||||||
add [additional icons].
|
|
||||||
|
|
||||||
[icon integration]: extensions/python-markdown-extensions.md#emoji
|
In order to customize and override the [copyright notice], [extend the theme]
|
||||||
[additional icons]: changing-the-logo-and-icons.md#additional-icons
|
and [override the `copyright` block][overriding blocks], which is normally set
|
||||||
|
to the `copyright` property set in `mkdocs.yml`:
|
||||||
|
|
||||||
|
``` html
|
||||||
|
{% extends "base.html" %}
|
||||||
|
|
||||||
|
{% block copyright %}
|
||||||
|
<!-- Add copyright here, including arbitrary HTML -->
|
||||||
|
{% endblock %}
|
||||||
|
```
|
||||||
|
|
||||||
|
[Custom copyright support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
||||||
|
[copyright notice]: #copyright-notice
|
||||||
|
[generator notice]: #generator-notice
|
||||||
|
[extend the theme]: ../customization.md#extending-the-theme
|
||||||
|
[overriding blocks]: ../customization.md#overriding-blocks
|
||||||
|
@ -16,6 +16,56 @@ Show the currently installed version with:
|
|||||||
pip show mkdocs-material
|
pip show mkdocs-material
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Upgrading from 7.x to 8.x
|
||||||
|
|
||||||
|
### What's new?
|
||||||
|
|
||||||
|
- Added support for code annotations
|
||||||
|
- Added support for anchor tracking
|
||||||
|
- Added support for version warning
|
||||||
|
- Added `copyright` partial for easier override
|
||||||
|
- Removed deprecated content tabs legacy implementation
|
||||||
|
- Removed deprecated `seealso` admonition type
|
||||||
|
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
||||||
|
- Removed deprecated prebuilt search index support
|
||||||
|
- Removed deprecated web app manifest
|
||||||
|
- Removed `extracopyright` variable
|
||||||
|
- Removed Disqus integation in favor of overrides
|
||||||
|
- Switched to `:is()` selectors for simple selector lists
|
||||||
|
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
||||||
|
- Improved CSS overall to match modern standards
|
||||||
|
- Improved CSS variable semantics for fonts
|
||||||
|
- Improved extensibility by restructuring partials
|
||||||
|
- Improved handling of `details` when printing
|
||||||
|
- Improved keyboard navigation for footnotes
|
||||||
|
- Fixed #3214: Search highlighting breaks site when empty
|
||||||
|
|
||||||
|
### Changes to `mkdocs.yml`
|
||||||
|
|
||||||
|
#### `pymdownx.tabbed`
|
||||||
|
|
||||||
|
Support for the legacy style of the [Tabbed] extension was dropped in favor
|
||||||
|
of the new, alternate implementation which has [better behavior on mobile
|
||||||
|
viewports]:
|
||||||
|
|
||||||
|
=== "8.x"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
markdown_extensions:
|
||||||
|
- pymdownx.tabbed:
|
||||||
|
alternate_style: true
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "7.x"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
markdown_extensions:
|
||||||
|
- pymdownx.tabbed
|
||||||
|
```
|
||||||
|
|
||||||
|
[Tabbed]: setup/extensions/python-markdown-extensions.md#tabbed
|
||||||
|
[better behavior on mobile viewports]: https://twitter.com/squidfunk/status/1424740370596958214
|
||||||
|
|
||||||
## Upgrading from 6.x to 7.x
|
## Upgrading from 6.x to 7.x
|
||||||
|
|
||||||
### What's new?
|
### What's new?
|
||||||
|
File diff suppressed because one or more lines are too long
29
material/assets/javascripts/bundle.c4fbc467.min.js
vendored
Normal file
29
material/assets/javascripts/bundle.c4fbc467.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -184,7 +184,7 @@
|
|||||||
"base": base_url,
|
"base": base_url,
|
||||||
"features": features,
|
"features": features,
|
||||||
"translations": {},
|
"translations": {},
|
||||||
"search": "assets/javascripts/workers/search.4b3933ee.min.js" | url
|
"search": "assets/javascripts/workers/search.01824240.min.js" | url
|
||||||
} -%}
|
} -%}
|
||||||
{%- if config.extra.version -%}
|
{%- if config.extra.version -%}
|
||||||
{%- set _ = app.update({ "version": config.extra.version }) -%}
|
{%- set _ = app.update({ "version": config.extra.version }) -%}
|
||||||
@ -213,7 +213,7 @@
|
|||||||
</script>
|
</script>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
{% block scripts %}
|
{% block scripts %}
|
||||||
<script src="{{ 'assets/javascripts/bundle.0cf2fc9f.min.js' | url }}"></script>
|
<script src="{{ 'assets/javascripts/bundle.c4fbc467.min.js' | url }}"></script>
|
||||||
{% for path in config["extra_javascript"] %}
|
{% for path in config["extra_javascript"] %}
|
||||||
<script src="{{ path | url }}"></script>
|
<script src="{{ path | url }}"></script>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
@ -60,7 +60,7 @@ theme:
|
|||||||
- navigation.tabs
|
- navigation.tabs
|
||||||
# - navigation.tabs.sticky
|
# - navigation.tabs.sticky
|
||||||
- navigation.top
|
- navigation.top
|
||||||
- navigation.tracking
|
# - navigation.tracking
|
||||||
- search.highlight
|
- search.highlight
|
||||||
- search.share
|
- search.share
|
||||||
- search.suggest
|
- search.suggest
|
||||||
|
Loading…
Reference in New Issue
Block a user