diff --git a/CHANGELOG b/CHANGELOG index c8f403ee2..448513154 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,52 @@ +mkdocs-material-9.2.0 (2023-08-21) + + Additions and improvements + + * Added blogging support via built-in blog plugin + * Added support for Chinese language segmentaiton in search plugin + * Added support for adding custom dates to blog posts + * Added support for paginating archive and category pages + * Added support for annotations (outside of code blocks) + * Added support for navigation icons + * Added support for navigation pruning + * Added support for navigation status + * Added support for customizing site icons + * Added support for customizing (code) annotation icons + * Added focus outline to admonitions and details + * Added prompt for bug report name to info plugin + * Added Luxembourgish translations + * Improved rendering of (code) annotation markers + * Improved print styles for (code) annotations + * Improved customizability of navigation tabs + * Improved interop of plugins with external tools like mike + * Improved interop of blog plugin with awesome pages plugin + * Improved header partial by moving buttons into separate partials + * Improved clarity of site_url warning in social plugin + * Improved blog plugin to automatically setup directory structure + * Switched info plugin to importlib to mitigate deprecations + * Automatically download ResizeObserver polyfill when necessary + * Automatically add iframe-worker polyfill when necessary in offline plugin + * Automatically focus and bring up keyboard on touch devices + * Updated Serbo-Croatian translations + * Updated MkDocs to 1.5.2 + + Removals + + * Removed Universal Analytics integration + * Removed ancient polyfills to reduce size of bundled JavaScript by 20% + * Removed necessity for Array.flat and Array.flatMap polyfill + * Removed announcement bar button when JavaScript is not available + + Fixes + + * Fixed rendering of tags when announcement bar is present + * Fixed tags plugin rendering pages excluded by other plugins + * Fixed #5132: Blog plugin requires nav entry in mkdocs.yml + * Fixed #5599: Insufficient contrast for default link color + * Fixed #5715: Blog plugin missing integrated table of contents in pagination + * Fixed #5806: Version selector not hoverable on some Android devices + * Fixed #5826: Blog post drafts with tags show up in tags index + mkdocs-material-9.1.21+insiders-4.39.0 (2023-08-01) * Added support for hoisting theme media files when building projects @@ -46,6 +95,24 @@ mkdocs-material-9.1.18+insiders-4.37.0 (2023-07-07) * Fixed jumping of content tabs anchor links when instant loading is enabled * Fixed #5676: Optimize plugin doesn't check for pngquant +mkdocs-material-9.2.0 (2023-07-06) + + * Added blogging support via built-in blog plugin + * Added Chinese language support to built-in search plugin + * Added support for annotations (outside of code blocks) + * Added support for navigation icons + * Added support for navigation pruning + * Added support for navigation status + * Added support for customizing site icons + * Improved rendering of (code) annotation markers + * Improved print styles for (code) annotations + * Improved customizability of navigation tabs + * Removed Universal Analytics integration + * Removed ancient polyfills to reduce size of bundled JavaScript by 20% + * Removed necessity for Array.flat and Array.flatMap polyfill + * Removed announcement bar button when JavaScript is not available + * Automatically download ResizeObserver polyfill when necessary + mkdocs-material-9.1.18 (2023-07-03) * Updated Danish translations diff --git a/docs/browser-support.md b/docs/browser-support.md index e24d4fb93..06ad4eb12 100644 --- a/docs/browser-support.md +++ b/docs/browser-support.md @@ -47,6 +47,8 @@ check the distribution of browser types and versions among your users. [open an issue]: https://github.com/squidfunk/mkdocs-material/issues/new/choose [caniuse.com]: https://caniuse.com/ [:is pseudo selector]: https://caniuse.com/css-matches-pseudo + [browser support]: #supported-browsers + [built-in privacy plugin]: setup/ensuring-data-privacy.md#built-in-privacy-plugin ## Other browsers diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 77f132477..86f835fd2 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -2,6 +2,55 @@ ## Material for MkDocs +### 9.2.0 July 6, 2023 { id="9.2.0" } + +__Additions and improvements__ + +- Added blogging support via built-in blog plugin +- Added support for Chinese language segmentaiton in search plugin +- Added support for adding custom dates to blog posts +- Added support for paginating archive and category pages +- Added support for annotations (outside of code blocks) +- Added support for navigation icons +- Added support for navigation pruning +- Added support for navigation status +- Added support for customizing site icons +- Added support for customizing (code) annotation icons +- Added focus outline to admonitions and details +- Added prompt for bug report name to info plugin +- Added Luxembourgish translations +- Improved rendering of (code) annotation markers +- Improved print styles for (code) annotations +- Improved customizability of navigation tabs +- Improved interop of plugins with external tools like mike +- Improved interop of blog plugin with awesome pages plugin +- Improved header partial by moving buttons into separate partials +- Improved clarity of `site_url` warning in social plugin +- Improved blog plugin to automatically setup directory structure +- Switched info plugin to `importlib` to mitigate deprecations +- Automatically download ResizeObserver polyfill when necessary +- Automatically add iframe-worker polyfill when necessary in offline plugin +- Automatically focus and bring up keyboard on touch devices +- Updated Serbo-Croatian translations +- Updated MkDocs to 1.5.2 + +__Removals__ + +- Removed Universal Analytics integration +- Removed ancient polyfills to reduce size of bundled JavaScript by 20% +- Removed necessity for `Array.flat` and `Array.flatMap` polyfill +- Removed announcement bar button when JavaScript is not available + +__Fixes__ + +- Fixed rendering of tags when announcement bar is present +- Fixed tags plugin rendering pages excluded by other plugins +- Fixed #5132: Blog plugin requires `nav` entry in `mkdocs.yml` +- Fixed #5599: Insufficient contrast for default link color +- Fixed #5715: Blog plugin missing integrated table of contents in pagination +- Fixed #5806: Version selector not hoverable on some Android devices +- Fixed #5826: Blog post drafts with tags show up in tags index + ### 9.1.21 July 27, 2023 { id="9.1.20" } - Fixed MkDocs 1.4 compat issue in social plugin (9.1.20 regression) diff --git a/docs/customization.md b/docs/customization.md index e448db7c2..807d19cac 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -100,6 +100,7 @@ assets may also be put in the `overrides` directory: │ │ └─ analytics.html # Analytics setup │ ├─ languages/ # Translation languages │ ├─ actions.html # Actions +│ ├─ alternate.html # Site language selector │ ├─ comments.html # Comment system (empty by default) │ ├─ consent.html # Consent │ ├─ content.html # Page content @@ -113,6 +114,7 @@ assets may also be put in the `overrides` directory: │ ├─ nav.html # Main navigation │ ├─ nav-item.html # Main navigation item │ ├─ pagination.html # Pagination (used for blog) +│ ├─ palette.html # Color palette toggle │ ├─ post.html # Blog post excerpt │ ├─ search.html # Search interface │ ├─ social.html # Social links diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md index 6ab8458fa..f625a9e54 100644 --- a/docs/reference/annotations.md +++ b/docs/reference/annotations.md @@ -31,11 +31,51 @@ See additional configuration options: [Markdown in HTML]: ../setup/extensions/python-markdown.md#markdown-in-html [SuperFences]: ../setup/extensions/python-markdown-extensions.md#superfences +### Annotation icons + +[:octicons-tag-24: 9.2.0][Annotation icons support] + +The annotation icon can be changed to any icon bundled with the theme, or even +a [custom icon], e.g. to material/arrow-right-circle:. Simply add the following +lines to `mkdocs.yml`: + +``` yaml +theme: + icon: + annotation: material/arrow-right-circle # (1)! +``` + +1. Enter a few keywords to find the perfect icon using our [icon search] and + click on the shortcode to copy it to your clipboard: + +
+ +Some popular choices: + +- :material-plus-circle: - `material/plus-circle` +- :material-circle-medium: - `material/circle-medium` +- :material-record-circle: - `material/record-circle` +- :material-arrow-right-circle: - `material/arrow-right-circle` +- :material-arrow-right-circle-outline: - `material/arrow-right-circle-outline` +- :material-chevron-right-circle: - `material/chevron-right-circle` +- :material-star-four-points-circle: - `material/star-four-points-circle` +- :material-plus-circle-outline: - `material/plus-circle-outline` + + [Annotation icons support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0 + [custom icon]: ../setup/changing-the-logo-and-icons.md#additional-icons + [icon search]: icons-emojis.md#search + ## Usage ### Using annotations -[:octicons-tag-24: 9.2.0b0][Annotation support] · +[:octicons-tag-24: 9.2.0][Annotation support] · :octicons-beaker-24: Experimental Annotations consist of two parts: a marker, which can be placed anywhere in @@ -64,7 +104,7 @@ Note that the `annotate` class must only be added to the outermost block. All nested elements can use the same list to define annotations, except when annotations are nested themselves. - [Annotation support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0b0 + [Annotation support]: https://github.com/squidfunk/mkdocs-material/releases/tag/9.2.0 #### in annotations diff --git a/docs/reference/images.md b/docs/reference/images.md index c13cf86ee..824e13502 100644 --- a/docs/reference/images.md +++ b/docs/reference/images.md @@ -136,6 +136,21 @@ but it's always possible to use the [Markdown in HTML] extension with literal + +Another option is to use [Markdown captions](https://github.com/Evidlo/markdown_captions) extension +which converts images with alt text to \