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
2673cafe47
commit
a644f57711
@ -23,8 +23,5 @@ docs
|
|||||||
material
|
material
|
||||||
src/**/*.html
|
src/**/*.html
|
||||||
|
|
||||||
# Don't lint shame
|
|
||||||
src/assets/stylesheets/_shame.scss
|
|
||||||
|
|
||||||
# Prevent stylelint from constantly complaining
|
# Prevent stylelint from constantly complaining
|
||||||
*.ts
|
*.ts
|
||||||
|
@ -8,10 +8,6 @@ template: overrides/main.html
|
|||||||
|
|
||||||
### 8.0.0 <small>_ November 28, 2021</small> { id="8.0.0" }
|
### 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 code annotations
|
||||||
- Added support for anchor tracking
|
- Added support for anchor tracking
|
||||||
- Added support for version warning
|
- Added support for version warning
|
||||||
@ -20,9 +16,9 @@ the [upgrade guide] for instructions._
|
|||||||
- Removed deprecated `seealso` admonition type
|
- Removed deprecated `seealso` admonition type
|
||||||
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
||||||
- Removed deprecated prebuilt search index support
|
- Removed deprecated prebuilt search index support
|
||||||
- Removed deprecated web app manifest
|
- Removed deprecated web app manifest – use customization
|
||||||
- Removed `extracopyright` variable
|
- Removed `extracopyright` variable – use new `copyright` partial
|
||||||
- Removed Disqus integation in favor of overrides
|
- Removed Disqus integation – use customization
|
||||||
- Switched to `:is()` selectors for simple selector lists
|
- Switched to `:is()` selectors for simple selector lists
|
||||||
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
||||||
- Improved CSS overall to match modern standards
|
- Improved CSS overall to match modern standards
|
||||||
@ -32,8 +28,6 @@ the [upgrade guide] for instructions._
|
|||||||
- Improved keyboard navigation for footnotes
|
- Improved keyboard navigation for footnotes
|
||||||
- Fixed #3214: Search highlighting breaks site when empty
|
- 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
|
||||||
|
@ -41,7 +41,7 @@ especially useful for large documentation sites.
|
|||||||
|
|
||||||
### Anchor tracking
|
### Anchor tracking
|
||||||
|
|
||||||
[:octicons-tag-24: 8.0.0b1][Anchor tracking support] ·
|
[:octicons-tag-24: 8.0.0][Anchor tracking support] ·
|
||||||
:octicons-unlock-24: Feature flag ·
|
:octicons-unlock-24: Feature flag ·
|
||||||
:octicons-beaker-24: Experimental
|
:octicons-beaker-24: Experimental
|
||||||
|
|
||||||
@ -55,7 +55,7 @@ theme:
|
|||||||
- navigation.tracking
|
- navigation.tracking
|
||||||
```
|
```
|
||||||
|
|
||||||
[Anchor tracking support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
|
[Anchor tracking support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
||||||
|
|
||||||
### Navigation tabs
|
### Navigation tabs
|
||||||
|
|
||||||
|
@ -62,7 +62,7 @@ Check out the versioning example to see it in action –
|
|||||||
|
|
||||||
### Version warning
|
### Version warning
|
||||||
|
|
||||||
[:octicons-tag-24: 8.0.0b1][Version warning support] ·
|
[:octicons-tag-24: 8.0.0][Version warning support] ·
|
||||||
:octicons-file-symlink-file-24: Customization
|
:octicons-file-symlink-file-24: Customization
|
||||||
|
|
||||||
If you're using versioning, you might want to display a warning when the user
|
If you're using versioning, you might want to display a warning when the user
|
||||||
@ -102,7 +102,7 @@ extra:
|
|||||||
|
|
||||||
Make sure that this matches the [default version].
|
Make sure that this matches the [default version].
|
||||||
|
|
||||||
[Version warning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0b1
|
[Version warning support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0
|
||||||
[theme extension]: ../customization.md#extending-the-theme
|
[theme extension]: ../customization.md#extending-the-theme
|
||||||
[overriding blocks]: ../customization.md#overriding-blocks
|
[overriding blocks]: ../customization.md#overriding-blocks
|
||||||
[Version warning preview]: ../assets/screenshots/version-warning.png
|
[Version warning preview]: ../assets/screenshots/version-warning.png
|
||||||
|
168
docs/upgrade.md
168
docs/upgrade.md
@ -28,9 +28,9 @@ pip show mkdocs-material
|
|||||||
- Removed deprecated `seealso` admonition type
|
- Removed deprecated `seealso` admonition type
|
||||||
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
- Removed deprecated `site_keywords` setting (unsupported by MkDocs)
|
||||||
- Removed deprecated prebuilt search index support
|
- Removed deprecated prebuilt search index support
|
||||||
- Removed deprecated web app manifest
|
- Removed deprecated web app manifest – use customization
|
||||||
- Removed `extracopyright` variable
|
- Removed `extracopyright` variable – use new `copyright` partial
|
||||||
- Removed Disqus integation in favor of overrides
|
- Removed Disqus integation – use customization
|
||||||
- Switched to `:is()` selectors for simple selector lists
|
- Switched to `:is()` selectors for simple selector lists
|
||||||
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
- Switched autoprefixer from `last 4 years` to `last 2 years`
|
||||||
- Improved CSS overall to match modern standards
|
- Improved CSS overall to match modern standards
|
||||||
@ -78,6 +78,102 @@ matches the new structure:
|
|||||||
|
|
||||||
=== ":octicons-file-code-16: base.html"
|
=== ":octicons-file-code-16: base.html"
|
||||||
|
|
||||||
|
``` diff
|
||||||
|
@@ -13,11 +13,6 @@
|
||||||
|
{% elif config.site_description %}
|
||||||
|
<meta name="description" content="{{ config.site_description }}">
|
||||||
|
{% endif %}
|
||||||
|
- {% if page and page.meta and page.meta.keywords %}
|
||||||
|
- <meta name="keywords" content="{{ page.meta.keywords }}">
|
||||||
|
- {% elif config.site_keywords %}
|
||||||
|
- <meta name="keywords" content="{{ config.site_keywords }}">
|
||||||
|
- {% endif %}
|
||||||
|
{% if page and page.meta and page.meta.author %}
|
||||||
|
<meta name="author" content="{{ page.meta.author }}">
|
||||||
|
{% elif config.site_author %}
|
||||||
|
@@ -61,15 +56,13 @@
|
||||||
|
font.text | replace(' ', '+') + ':300,400,400i,700%7C' +
|
||||||
|
font.code | replace(' ', '+')
|
||||||
|
}}&display=fallback">
|
||||||
|
- <style>:root{--md-text-font-family:"{{ font.text }}";--md-code-font-family:"{{ font.code }}"}</style>
|
||||||
|
+ <style>:root{--md-text-font:"{{ font.text }}";--md-code-font:"{{ font.code }}"}</style>
|
||||||
|
{% endif %}
|
||||||
|
{% endblock %}
|
||||||
|
- {% if config.extra.manifest %}
|
||||||
|
- <link rel="manifest" href="{{ config.extra.manifest | url }}" crossorigin="use-credentials">
|
||||||
|
- {% endif %}
|
||||||
|
{% for path in config["extra_css"] %}
|
||||||
|
<link rel="stylesheet" href="{{ path | url }}">
|
||||||
|
{% endfor %}
|
||||||
|
+ {% include "partials/javascripts/base.html" %}
|
||||||
|
{% block analytics %}
|
||||||
|
{% include "partials/integrations/analytics.html" %}
|
||||||
|
{% endblock %}
|
||||||
|
@@ -89,7 +82,6 @@
|
||||||
|
<body dir="{{ direction }}">
|
||||||
|
{% endif %}
|
||||||
|
{% set features = config.theme.features or [] %}
|
||||||
|
- {% include "partials/javascripts/base.html" %}
|
||||||
|
{% if not config.theme.palette is mapping %}
|
||||||
|
{% include "partials/javascripts/palette.html" %}
|
||||||
|
{% endif %}
|
||||||
|
@@ -106,13 +98,25 @@
|
||||||
|
</div>
|
||||||
|
<div data-md-component="announce">
|
||||||
|
{% if self.announce() %}
|
||||||
|
- <aside class="md-banner md-announce">
|
||||||
|
- <div class="md-banner__inner md-announce__inner md-grid md-typeset">
|
||||||
|
+ <aside class="md-banner">
|
||||||
|
+ <div class="md-banner__inner md-grid md-typeset">
|
||||||
|
{% block announce %}{% endblock %}
|
||||||
|
</div>
|
||||||
|
</aside>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
+ {% if config.extra.version %}
|
||||||
|
+ <div data-md-component="outdated" hidden>
|
||||||
|
+ <aside class="md-banner md-banner--warning">
|
||||||
|
+ {% if self.outdated() %}
|
||||||
|
+ <div class="md-banner__inner md-grid md-typeset">
|
||||||
|
+ {% block outdated %}{% endblock %}
|
||||||
|
+ </div>
|
||||||
|
+ {% include "partials/javascripts/outdated.html" %}
|
||||||
|
+ {% endif %}
|
||||||
|
+ </aside>
|
||||||
|
+ </div>
|
||||||
|
+ {% endif %}
|
||||||
|
{% block header %}
|
||||||
|
{% include "partials/header.html" %}
|
||||||
|
{% endblock %}
|
||||||
|
@@ -156,25 +160,7 @@
|
||||||
|
<div class="md-content" data-md-component="content">
|
||||||
|
<article class="md-content__inner md-typeset">
|
||||||
|
{% block content %}
|
||||||
|
- {% if page.edit_url %}
|
||||||
|
- <a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-content__button md-icon">
|
||||||
|
- {% include ".icons/material/pencil.svg" %}
|
||||||
|
- </a>
|
||||||
|
- {% endif %}
|
||||||
|
- {% if not "\x3ch1" in page.content %}
|
||||||
|
- <h1>{{ page.title | d(config.site_name, true)}}</h1>
|
||||||
|
- {% endif %}
|
||||||
|
- {{ page.content }}
|
||||||
|
- {% if page and page.meta %}
|
||||||
|
- {% if page.meta.git_revision_date_localized or
|
||||||
|
- page.meta.revision_date
|
||||||
|
- %}
|
||||||
|
- {% include "partials/source-file.html" %}
|
||||||
|
- {% endif %}
|
||||||
|
- {% endif %}
|
||||||
|
- {% endblock %}
|
||||||
|
- {% block disqus %}
|
||||||
|
- {% include "partials/integrations/disqus.html" %}
|
||||||
|
+ {% include "partials/content.html" %}
|
||||||
|
{% endblock %}
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
```
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -38,13 +38,6 @@
|
@@ -38,13 +38,6 @@
|
||||||
<meta name="description" content="{{ config.site_description }}" />
|
<meta name="description" content="{{ config.site_description }}" />
|
||||||
@ -213,30 +309,10 @@ matches the new structure:
|
|||||||
=== ":octicons-file-code-16: partials/copyright.html"
|
=== ":octicons-file-code-16: partials/copyright.html"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -0,0 +1,39 @@
|
@@ -0,0 +1,16 @@
|
||||||
+<!--
|
+{#-
|
||||||
+ Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
|
+ This file was automatically generated - do not edit
|
||||||
+
|
+-#}
|
||||||
+ Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
+ of this software and associated documentation files (the "Software"), to
|
|
||||||
+ deal in the Software without restriction, including without limitation the
|
|
||||||
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
||||||
+ sell copies of the Software, and to permit persons to whom the Software is
|
|
||||||
+ furnished to do so, subject to the following conditions:
|
|
||||||
+
|
|
||||||
+ The above copyright notice and this permission notice shall be included in
|
|
||||||
+ all copies or substantial portions of the Software.
|
|
||||||
+
|
|
||||||
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
||||||
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
||||||
+ IN THE SOFTWARE.
|
|
||||||
+-->
|
|
||||||
+
|
|
||||||
+<!-- Copyright and theme information -->
|
|
||||||
+<div class="md-copyright">
|
+<div class="md-copyright">
|
||||||
+ {% if config.copyright %}
|
+ {% if config.copyright %}
|
||||||
+ <div class="md-copyright__highlight">
|
+ <div class="md-copyright__highlight">
|
||||||
@ -245,10 +321,7 @@ matches the new structure:
|
|||||||
+ {% endif %}
|
+ {% endif %}
|
||||||
+ {% if not config.extra.generator == false %}
|
+ {% if not config.extra.generator == false %}
|
||||||
+ Made with
|
+ Made with
|
||||||
+ <a
|
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
+ href="https://squidfunk.github.io/mkdocs-material/"
|
|
||||||
+ target="_blank" rel="noopener"
|
|
||||||
+ >
|
|
||||||
+ Material for MkDocs
|
+ Material for MkDocs
|
||||||
+ </a>
|
+ </a>
|
||||||
+ {% endif %}
|
+ {% endif %}
|
||||||
@ -258,12 +331,10 @@ matches the new structure:
|
|||||||
=== ":octicons-file-code-16: partials/footer.html"
|
=== ":octicons-file-code-16: partials/footer.html"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -83,28 +81,12 @@
|
@@ -41,21 +40,10 @@
|
||||||
<!-- Further information -->
|
{% endif %}
|
||||||
<div class="md-footer-meta md-typeset">
|
<div class="md-footer-meta md-typeset">
|
||||||
<div class="md-footer-meta__inner md-grid">
|
<div class="md-footer-meta__inner md-grid">
|
||||||
-
|
|
||||||
- <!-- Copyright and theme information -->
|
|
||||||
- <div class="md-footer-copyright">
|
- <div class="md-footer-copyright">
|
||||||
- {% if config.copyright %}
|
- {% if config.copyright %}
|
||||||
- <div class="md-footer-copyright__highlight">
|
- <div class="md-footer-copyright__highlight">
|
||||||
@ -272,19 +343,14 @@ matches the new structure:
|
|||||||
- {% endif %}
|
- {% endif %}
|
||||||
- {% if not config.extra.generator == false %}
|
- {% if not config.extra.generator == false %}
|
||||||
- Made with
|
- Made with
|
||||||
- <a
|
- <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||||||
- href="https://squidfunk.github.io/mkdocs-material/"
|
|
||||||
- target="_blank" rel="noopener"
|
|
||||||
- >
|
|
||||||
- Material for MkDocs
|
- Material for MkDocs
|
||||||
- </a>
|
- </a>
|
||||||
- {% endif %}
|
- {% endif %}
|
||||||
- {{ extracopyright }}
|
- {{ extracopyright }}
|
||||||
- </div>
|
- </div>
|
||||||
+ {% include "partials/copyright.html" %}
|
|
||||||
|
|
||||||
<!-- Social links -->
|
|
||||||
- {% include "partials/social.html" %}
|
- {% include "partials/social.html" %}
|
||||||
|
+ {% include "partials/copyright.html" %}
|
||||||
+ {% if config.extra.social %}
|
+ {% if config.extra.social %}
|
||||||
+ {% include "partials/social.html" %}
|
+ {% include "partials/social.html" %}
|
||||||
+ {% endif %}
|
+ {% endif %}
|
||||||
@ -296,8 +362,7 @@ matches the new structure:
|
|||||||
=== ":octicons-file-code-16: partials/social.html"
|
=== ":octicons-file-code-16: partials/social.html"
|
||||||
|
|
||||||
``` diff
|
``` diff
|
||||||
@@ -22,23 +22,21 @@
|
@@ -4,17 +4,15 @@
|
||||||
-<!-- Social links in footer -->
|
|
||||||
-{% if config.extra.social %}
|
-{% if config.extra.social %}
|
||||||
- <div class="md-footer-social">
|
- <div class="md-footer-social">
|
||||||
- {% for social in config.extra.social %}
|
- {% for social in config.extra.social %}
|
||||||
@ -306,18 +371,12 @@ matches the new structure:
|
|||||||
- {% set _,url = social.link.split("//") %}
|
- {% set _,url = social.link.split("//") %}
|
||||||
- {% set title = url.split("/")[0] %}
|
- {% set title = url.split("/")[0] %}
|
||||||
- {% endif %}
|
- {% endif %}
|
||||||
- <a
|
- <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title | e }}" class="md-footer-social__link">
|
||||||
- href="{{ social.link }}"
|
|
||||||
- target="_blank" rel="noopener"
|
|
||||||
- title="{{ title | e }}"
|
|
||||||
- class="md-footer-social__link"
|
|
||||||
- >
|
|
||||||
- {% include ".icons/" ~ social.icon ~ ".svg" %}
|
- {% include ".icons/" ~ social.icon ~ ".svg" %}
|
||||||
- </a>
|
- </a>
|
||||||
- {% endfor %}
|
- {% endfor %}
|
||||||
- </div>
|
- </div>
|
||||||
-{% endif %}
|
-{% endif %}
|
||||||
+<!-- Social links -->
|
|
||||||
+<div class="md-social">
|
+<div class="md-social">
|
||||||
+ {% for social in config.extra.social %}
|
+ {% for social in config.extra.social %}
|
||||||
+ {% set title = social.name %}
|
+ {% set title = social.name %}
|
||||||
@ -325,12 +384,7 @@ matches the new structure:
|
|||||||
+ {% set _, url = social.link.split("//") %}
|
+ {% set _, url = social.link.split("//") %}
|
||||||
+ {% set title = url.split("/")[0] %}
|
+ {% set title = url.split("/")[0] %}
|
||||||
+ {% endif %}
|
+ {% endif %}
|
||||||
+ <a
|
+ <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title | e }}" class="md-social__link">
|
||||||
+ href="{{ social.link }}"
|
|
||||||
+ target="_blank" rel="noopener"
|
|
||||||
+ title="{{ title | e }}"
|
|
||||||
+ class="md-social__link"
|
|
||||||
+ >
|
|
||||||
+ {% include ".icons/" ~ social.icon ~ ".svg" %}
|
+ {% include ".icons/" ~ social.icon ~ ".svg" %}
|
||||||
+ </a>
|
+ </a>
|
||||||
+ {% endfor %}
|
+ {% endfor %}
|
||||||
|
Loading…
Reference in New Issue
Block a user