diff --git a/.stylelintignore b/.stylelintignore index 53f05f0ab..ee8e62e39 100644 --- a/.stylelintignore +++ b/.stylelintignore @@ -23,8 +23,5 @@ docs material src/**/*.html -# Don't lint shame -src/assets/stylesheets/_shame.scss - # Prevent stylelint from constantly complaining *.ts diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 29f3f144d..99b2a7cc0 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -8,10 +8,6 @@ template: overrides/main.html ### 8.0.0 _ November 28, 2021 { 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 @@ -20,9 +16,9 @@ the [upgrade guide] for instructions._ - 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 +- Removed deprecated web app manifest – use customization +- Removed `extracopyright` variable – use new `copyright` partial +- Removed Disqus integation – use customization - 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 @@ -32,8 +28,6 @@ the [upgrade guide] for instructions._ - 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 _ October 30, 2021 { id="7.3.6" } - Added support for adding titles to code blocks diff --git a/docs/customization.md b/docs/customization.md index ae39875f4..2af26ca0f 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -97,7 +97,7 @@ assets may also be put in the `overrides` directory: ├─ assets/ │ ├─ images/ # Images and icons │ ├─ javascripts/ # JavaScript files -│ └─ stylesheets/ # Stylesheets +│ └─ stylesheets/ # Style sheets ├─ partials/ │ ├─ integrations/ # Third-party integrations │ │ ├─ analytics/ # Analytics integrations diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 04b136d3c..4b5758cf7 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -41,7 +41,7 @@ especially useful for large documentation sites. ### 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-beaker-24: Experimental @@ -55,7 +55,7 @@ theme: - 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 diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index 923dd57e2..ee6c8fb96 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -62,7 +62,7 @@ Check out the versioning example to see it in action – ### 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 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]. - [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 [overriding blocks]: ../customization.md#overriding-blocks [Version warning preview]: ../assets/screenshots/version-warning.png diff --git a/docs/upgrade.md b/docs/upgrade.md index 69fd2bd38..3cca843a6 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -28,9 +28,9 @@ pip show mkdocs-material - 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 +- Removed deprecated web app manifest – use customization +- Removed `extracopyright` variable – use new `copyright` partial +- Removed Disqus integation – use customization - 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 @@ -78,6 +78,102 @@ matches the new structure: === ":octicons-file-code-16: base.html" + ``` diff + @@ -13,11 +13,6 @@ + {% elif config.site_description %} + + {% endif %} + - {% if page and page.meta and page.meta.keywords %} + - + - {% elif config.site_keywords %} + - + - {% endif %} + {% if page and page.meta and page.meta.author %} + + {% elif config.site_author %} + @@ -61,15 +56,13 @@ + font.text | replace(' ', '+') + ':300,400,400i,700%7C' + + font.code | replace(' ', '+') + }}&display=fallback"> + - + + + {% endif %} + {% endblock %} + - {% if config.extra.manifest %} + - + - {% endif %} + {% for path in config["extra_css"] %} + + {% endfor %} + + {% include "partials/javascripts/base.html" %} + {% block analytics %} + {% include "partials/integrations/analytics.html" %} + {% endblock %} + @@ -89,7 +82,6 @@ + + {% 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 @@ + +
+ {% if self.announce() %} + -