diff --git a/docs/bug-report/index.md b/docs/bug-report/index.md
index 39fd87569..3bf2b6f3a 100644
--- a/docs/bug-report/index.md
+++ b/docs/bug-report/index.md
@@ -3,7 +3,7 @@
Material for MkDocs is an actively maintained project that we constantly strive
to improve. With a project of this size and complexity, bugs may occur. If you
think you have discovered a bug, you can help us by submitting an issue in our
-public [issue tracker].
+public [issue tracker], following this guide.
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
@@ -311,5 +311,5 @@ __We'll take it from here.__
Please understand, that we reserve us the right to close incomplete issues which
do not contain minimal reproductions, or do not adhere to the quality standards
-and requirements mentioned in this document. We will try our best to help you
-improve your bug report in the comments.
+and requirements mentioned in this document. Issues can be reopened, when the
+missing information has been provided.
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
index 529fcdb40..e331ec455 100644
--- a/docs/changelog/index.md
+++ b/docs/changelog/index.md
@@ -2,64 +2,108 @@
## Material for MkDocs
-### 8.5.11 _ November 30, 2022 { id="8.5.11" }
+### 9.0.0 January 2, 2023 { id="9.0.0" }
+
+__Additions and improvements__
+
+- Added support for rich search previews
+- Added support for tokenizer lookahead
+- Added support for better search highlighting
+- Added support for excluding content from search
+- Added support for configurable search pipeline
+- Added support for offline search via offline plugin
+- Added support for multiple instances of built-in tags plugin
+- Added support for removing copy-to-clipboard button
+- Added support for removing footer navigation
+- Added support for button to view the source of a page
+- Improved readability of query string for search sharing
+- Improved stability of search plugin when using `--dirtyreload`
+- Improved search result group button, now sticky and stable
+- Updated Norwegian translations
+- Updated MkDocs to 1.4.2
+
+__Removals__
+
+- Removed deprecated alternative admonition qualifiers
+- Removed `:is()` selectors (in output) for easier overriding
+- Removed `.title` suffix on translations
+- Removed legacy method for providing page title in feedback URL
+- Removed support for indexing only titles in search
+- Removed support for custom search transforms
+- Removed support for custom search workers
+
+__Fixes__
+
+- Fixed Norwegian and Korean language code
+- Fixed detection of composition events in search interface
+- Fixed search plugin not using title set via front matter
+- Fixed search highlighting of tags
+- Fixed search sharing URL using post transformed string
+- Fixed theme-color meta tag getting out-of-sync with palette toggle
+- Fixed prev/next page keyboard navigation when footer is not present
+- Fixed overflowing navigation tabs not being scrollable
+- Fixed inclusion of code block line numbers from search
+
+---
+
+### 8.5.11 November 30, 2022 { id="8.5.11" }
- Let it snow, see https://twitter.com/squidfunk/status/1597939243090788352
-### 8.5.10 _ November 11, 2022 { id="8.5.10" }
+### 8.5.10 November 11, 2022 { id="8.5.10" }
- Adjusted CSS to better allow for custom primary and accent colors
- Fixed #4620: Primary color is not applied (8.5.9 regression)
-### 8.5.9 _ November 8, 2022 { id="8.5.9" }
+### 8.5.9 November 8, 2022 { id="8.5.9" }
- Fixed #4600: Illegible link colors for black and white primary colors
- Fixed #4594: Need to set schema to change link color
-### 8.5.8 _ November 3, 2022 { id="8.5.8" }
+### 8.5.8 November 3, 2022 { id="8.5.8" }
- Added support for always showing settings in cookie consent
- Fixed #4571: Buttons invisible if primary color is `white` or `black`
- Fixed #4517: Illegible note in sequence diagram when using `slate` scheme
-### 8.5.7 _ October 22, 2022 { id="8.5.7" }
+### 8.5.7 October 22, 2022 { id="8.5.7" }
- Deprecated additional admonition qualifiers to reduce size of CSS
- Fixed #4511: Search boost does not apply to sections
-### 8.5.6 _ October 2, 2022 { id="8.5.6" }
+### 8.5.6 October 2, 2022 { id="8.5.6" }
- Modernized appearance of admonitions (with fallback, see docs)
- Improved appearance of inline code blocks in admonition titles
-### 8.5.5 _ October 1, 2022 { id="8.5.5" }
+### 8.5.5 October 1, 2022 { id="8.5.5" }
- Updated MkDocs to 1.4
- Fixed compatibility issues with MkDocs 1.4
- Fixed #4430: build error when enabling consent without repository URL
-### 8.5.4 _ September 30, 2022 { id="8.5.4" }
+### 8.5.4 September 30, 2022 { id="8.5.4" }
- Fixed expand icons shift on sidebar overflow (using `scrollbar-gutter`)
- Fixed #4429: Text in sequence diagrams overflows in Firefox
-### 8.5.3 _ September 20, 2022 { id="8.5.3" }
+### 8.5.3 September 20, 2022 { id="8.5.3" }
- Fixed build error when enabling cookie consent without analytics
- Fixed #4381: Code blocks render ligatures for some fonts
-### 8.5.2 _ September 18, 2022 { id="8.5.2" }
+### 8.5.2 September 18, 2022 { id="8.5.2" }
- Updated Mermaid.js to version 9.1.7
- Fixed overly large headlines in search results (8.5.0 regression)
- Fixed #4358: Navigation sections appear as clickable (8.5.0 regression)
- Fixed #4356: GitHub repository statistics fetched before cookie consent
-### 8.5.1 _ September 15, 2022 { id="8.5.1" }
+### 8.5.1 September 15, 2022 { id="8.5.1" }
- Fixed #4366: Removed dependencies with native extensions
-### 8.5.0 _ September 13, 2022 { id="8.5.0" }
+### 8.5.0 September 13, 2022 { id="8.5.0" }
- Added support for social cards
- Added support for code annotation anchor links (deep linking)
@@ -68,11 +112,11 @@
- Added support for anchor following table of contents (= auto scroll)
- Added support for tag icons
-### 8.4.4 _ September 12, 2022 { id="8.4.4" }
+### 8.4.4 September 12, 2022 { id="8.4.4" }
- Moved comments integration to separate partial (`comments.html`)
-### 8.4.3 _ September 7, 2022 { id="8.4.3" }
+### 8.4.3 September 7, 2022 { id="8.4.3" }
- Added Simple Icons to bundled icons (+2,300 icons)
- Added support for changing edit icon
@@ -80,59 +124,59 @@
- Fixed #4291: Version switching doesn't stay on page when anchors are used
- Fixed #4327: Links in data tables do not receive link styling
-### 8.4.2 _ August 27, 2022 { id="8.4.2" }
+### 8.4.2 August 27, 2022 { id="8.4.2" }
- Updated Slovenian translations
- Fixed #4277: Feedback widget hidden after navigation with instant loading
- Fixed numeric tags in front matter breaking search functionality
-### 8.4.1 _ August 21, 2022 { id="8.4.1" }
+### 8.4.1 August 21, 2022 { id="8.4.1" }
- Updated Croatian and Hebrew translations
-### 8.4.0 _ August 13, 2022 { id="8.4.0" }
+### 8.4.0 August 13, 2022 { id="8.4.0" }
- Added support for cookie consent
- Added support for feedback widget (Was this page helpful?)
- Added support for dismissable announcement bar
- Added Armenian, Lithuanian, Tagalog, and Urdu translations
-### 8.3.9 _ July 4, 2022 { id="8.3.9" }
+### 8.3.9 July 4, 2022 { id="8.3.9" }
- Updated Taiwanese translations for search
- Allow ids for content tabs with special characters (for mkdocstrings)
- Fixed #4083: home not clickable when using versioning (8.3.5 regression)
-### 8.3.8 _ June 24, 2022 { id="8.3.8" }
+### 8.3.8 June 24, 2022 { id="8.3.8" }
- Fixed #4053: Limit width of videos to content area
- Fixed empty tags in front matter breaking search
-### 8.3.7 _ June 22, 2022 { id="8.3.7" }
+### 8.3.7 June 22, 2022 { id="8.3.7" }
- Fixed search being stuck initializing when using tags (8.3.4 regression)
-### 8.3.6 _ June 16, 2022 { id="8.3.6" }
+### 8.3.6 June 16, 2022 { id="8.3.6" }
- Fixed #4028: Links not clickable when using versioning (8.3.5 regression)
-### 8.3.5 _ June 14, 2022 { id="8.3.5" }
+### 8.3.5 June 14, 2022 { id="8.3.5" }
- Fixed #4012: Stay on page not working for alias of active version
-### 8.3.4 _ June 11, 2022 { id="8.3.4" }
+### 8.3.4 June 11, 2022 { id="8.3.4" }
- Fixed #4004: Tags with multiple words not searchable
-### 8.3.3 _ June 7, 2022 { id="8.3.3" }
+### 8.3.3 June 7, 2022 { id="8.3.3" }
- Fixed #4000: Mermaid diagrams too dark in dark mode (8.3.0 regression)
-### 8.3.2 _ June 5, 2022 { id="8.3.2" }
+### 8.3.2 June 5, 2022 { id="8.3.2" }
- Fixed #3987: Custom admonition icons don't work when defining color palette
-### 8.3.1 _ June 4, 2022 { id="8.3.1" }
+### 8.3.1 June 4, 2022 { id="8.3.1" }
- Bump required Jinja version to 3.0.2
- Removed unnecessary conditions in templates
@@ -140,7 +184,7 @@
- Fixed #3977: Content tabs snapping oddly in Firefox
- Fixed #3983: Missing condition in footer partial (8.3.0 regression)
-### 8.3.0 _ June 2, 2022 { id="8.3.0" }
+### 8.3.0 June 2, 2022 { id="8.3.0" }
- Added support for custom admonition icons
- Added support for linking of content tabs
@@ -149,38 +193,38 @@
- Added previous/next indicators to content tabs
- Improved typeset link colors in light and dark modes
-### 8.2.16 _ May 28, 2022 { id="8.2.16" }
+### 8.2.16 May 28, 2022 { id="8.2.16" }
- Fixed #3957: Only animate code annotations when visible (save CPU cycles)
-### 8.2.15 _ May 14, 2022 { id="8.2.15" }
+### 8.2.15 May 14, 2022 { id="8.2.15" }
- Added Uzbek translations
- Fixed spacing for code block results in content tabs
-### 8.2.14 _ May 8, 2022 { id="8.2.14" }
+### 8.2.14 May 8, 2022 { id="8.2.14" }
- Fixed missing top right rounded border on admonition
- Fixed #3886: `4xx` status codes not handled when using instant loading
-### 8.2.13 _ May 2, 2022 { id="8.2.13" }
+### 8.2.13 May 2, 2022 { id="8.2.13" }
- Fixed #3865: Tags index links to tagged pages 404 on Windows
- Fixed #3866: Bump required Python version from 3.6+ to 3.7+
-### 8.2.12 _ April 30, 2022 { id="8.2.12" }
+### 8.2.12 April 30, 2022 { id="8.2.12" }
- Added support for GitHub-style hash fragments for dark/light images
- Improved rendering of nested code blocks in content tabs and annotations
- Fixed #3862: Upgraded to latest Pygments and Python Markdown Extensions
-### 8.2.11 _ April 25, 2022 { id="8.2.11" }
+### 8.2.11 April 25, 2022 { id="8.2.11" }
- Temporarily pinned Pygments to `<2.12`
- Temporarily pinned Python Markdown Extensions to `<9.4`
- Improved rendering of code annotation markers
-### 8.2.10 _ April 24, 2022 { id="8.2.10" }
+### 8.2.10 April 24, 2022 { id="8.2.10" }
- Added Macedonian translations
- Updated Mermaid.js to version 9.0.1
@@ -188,7 +232,7 @@
- Fixed color of arrows in class and state diagrams for dark mode
- Fixed #3836: Inline admonitions overlayed by code block titles
-### 8.2.9 _ April 8, 2022 { id="8.2.9" }
+### 8.2.9 April 8, 2022 { id="8.2.9" }
- Mitigate flicker on color palette switch by disabling all transitions
- Fixed search suggestions not triggered when following deep link
@@ -196,7 +240,7 @@
- Fixed #3782: Admonition titles have extra pixels on wide screens in Firefox
- Fixed #3802: Always render table of contents container (except when hidden)
-### 8.2.8 _ March 27, 2022 { id="8.2.8" }
+### 8.2.8 March 27, 2022 { id="8.2.8" }
- Bumped MkDocs version to 1.3.0 to mitigate breaking changes in Jinja
- Reverted Jinja version range limitation (added in 8.2.7)
@@ -205,48 +249,48 @@
- Added check in tags plugin whether tags overview page exists
- Fixed #3744: Content tab indicator on wrong position when using back button
-### 8.2.7 _ March 24, 2022 { id="8.2.7" }
+### 8.2.7 March 24, 2022 { id="8.2.7" }
- Temporarily limit Jinja version range to < 3.1 due to breaking changes
-### 8.2.6 _ March 23, 2022 { id="8.2.6" }
+### 8.2.6 March 23, 2022 { id="8.2.6" }
- Fixed #3695: Deprecation warning for unescaped backslashes in templates
- Fixed #3696: Annotations not mounted in some Terraform code blocks
- Fixed #3698: Annotations not mounted in long code blocks (8.2.5 regression)
-### 8.2.5 _ March 6, 2022 { id="8.2.5" }
+### 8.2.5 March 6, 2022 { id="8.2.5" }
- Fixed #3596: Mermaid not working when headline with name 'Mermaid' present
- Fixed #3643: Reduce time to render pages with thousands of code blocks
- Fixed #3665: Missing styles for Mermaid.js flowcharts cluster labels
-### 8.2.4 _ March 2, 2022 { id="8.2.4" }
+### 8.2.4 March 2, 2022 { id="8.2.4" }
- Fixed malformed Google Fonts URL when a font setting was omitted
- Fixed #3648: Fixed specificity issue with admonitions in lists
- Fixed #3653: Invalid outdated version banner URL when using instant loading
-### 8.2.3 _ February 27, 2022 { id="8.2.3" }
+### 8.2.3 February 27, 2022 { id="8.2.3" }
- Fixed #3578: Active element in table of contents off-by-one on large screens
-### 8.2.2 _ February 26, 2022 { id="8.2.2" }
+### 8.2.2 February 26, 2022 { id="8.2.2" }
- Added automatic removal of query parameter when search is closed
- Fixed #3599: Anchors always overriden when using navigation tracking
-### 8.2.1 _ February 17, 2022 { id="8.2.1" }
+### 8.2.1 February 17, 2022 { id="8.2.1" }
- Fixed module `material.plugins` not being found (8.2.0 regression)
-### 8.2.0 _ February 17, 2022 { id="8.2.0" }
+### 8.2.0 February 17, 2022 { id="8.2.0" }
- Added native support for Mermaid.js diagrams
- Added native support for tags (with search integration)
- Added support for staying on page when switching versions
-### 8.1.11 _ February 10, 2022 { id="8.1.11" }
+### 8.1.11 February 10, 2022 { id="8.1.11" }
- Added Portuguese (Brasilian) translations
- Updated FontAwesome to v6 – [check which icons were renamed here]
@@ -254,60 +298,60 @@
[check which icons were renamed here]: https://fontawesome.com/docs/web/setup/upgrade/whats-changed#icons-renamed-in-version-6
-### 8.1.10 _ February 6, 2022 { id="8.1.10" }
+### 8.1.10 February 6, 2022 { id="8.1.10" }
- Fixed cutoff of very wide logos in the sidebar on mobile
-### 8.1.9 _ January 30, 2022 { id="8.1.9" }
+### 8.1.9 January 30, 2022 { id="8.1.9" }
- [Added support for `mkdocs.yml` validation and auto-complete][validation]
- Fixed errors in Latvian translations
[validation]: ../creating-your-site.md#minimal-configuration
-### 8.1.8 _ January 23, 2022 { id="8.1.8" }
+### 8.1.8 January 23, 2022 { id="8.1.8" }
- Added Latvian translations
- Updated Giscus example integration with dynamic theme change support
- Fixed #3479: Back-to-top button not hidden when using sticky navigation tabs
- Fixed #3491: Logo in header and drawer doesn't honor aspect ratio
-### 8.1.7 _ January 16, 2022 { id="8.1.7" }
+### 8.1.7 January 16, 2022 { id="8.1.7" }
- Improved back-to-top button behavior - now not shown on anchor jump
-### 8.1.6 _ January 11, 2022 { id="8.1.6" }
+### 8.1.6 January 11, 2022 { id="8.1.6" }
- Fixed spacing of blockquotes (8.1.5 regression)
- Fixed edge cases for rounded corners on code blocks (8.1.5 regression)
- Fixed issues with code annotation line heights
-### 8.1.5 _ January 9, 2022 { id="8.1.5" }
+### 8.1.5 January 9, 2022 { id="8.1.5" }
- Improved browser support: Chrome 49+, Safari 10+, Firefox 53+, Edge 79+
- Improved rendering of inline code blocks in headlines
- Added Bahasa Malaysian translations
- Fixed #3354: MathJax formulas show vertical scrollbar
-### 8.1.4 _ January 2, 2022 { id="8.1.4" }
+### 8.1.4 January 2, 2022 { id="8.1.4" }
- Added indicator to navigation expander icon
- Improved support for reduced motion preference
- Fixed jitter of active content tab indicator
-### 8.1.3 _ December 19, 2021 { id="8.1.3" }
+### 8.1.3 December 19, 2021 { id="8.1.3" }
- Added animation to active content tab indicator
- Fixed #3360: Highlighted lines add blank lines in copied text
- Fixed usage of subsequent index files when using section index pages
-### 8.1.2 _ December 15, 2021 { id="8.1.2" }
+### 8.1.2 December 15, 2021 { id="8.1.2" }
- Switched CSS sources to logical properties
- Added transformation of logical properties to `ltr`/`rtl` equivalents
- Fixed spacing for admonitions inside lists (8.1.1 regression)
-### 8.1.1 _ December 13, 2021 { id="8.1.1" }
+### 8.1.1 December 13, 2021 { id="8.1.1" }
- Added support for `#only-light` and `#only-dark` image hash fragments
- Fixed copy-to-clipboard adding blank lines when using line anchors
@@ -320,7 +364,7 @@
- Fixed #3343: Filtered stopwords appear as missing search terms
- Fixed #3346: Site unusable due to usage of `:not()` (Firefox 78 ESR)
-### 8.1.0 _ December 10, 2021 { id="8.1.0" }
+### 8.1.0 December 10, 2021 { id="8.1.0" }
- Added basic support for code block line anchors
- Switched code annotation markers to `+` signs to improve usability
@@ -330,12 +374,12 @@
- Improved and simplified code annotation positioning
- Fixed syntax error in Russian translations
-### 8.0.5 _ December 6, 2021 { id="8.0.5" }
+### 8.0.5 December 6, 2021 { id="8.0.5" }
- Fixed #3302: Footer refactoring induced ellipsis in some browsers
- Fixed #3313: Details always rendered closed on load (8.0.4 regression)
-### 8.0.4 _ December 4, 2021 { id="8.0.4" }
+### 8.0.4 December 4, 2021 { id="8.0.4" }
- Improved support for deeply nested code annotations
- Improved code annotation and copy-to-clipboard interop
@@ -345,24 +389,24 @@
- Fixed several positioning issues for code annotations
- Fixed JavaScript source map roots
-### 8.0.3 _ December 2, 2021 { id="8.0.3" }
+### 8.0.3 December 2, 2021 { id="8.0.3" }
- Removed deprecated `google_analytics` setting (was forgotten in 8.0.0)
- Fixed syntax error in Swedish and Polish translations
- Fixed #3283: Invalid back-to-top button position with sticky navigation tabs
- Fixed #3285: Default details marker showing due to Safari bug
-### 8.0.2 _ November 30, 2021 { id="8.0.2" }
+### 8.0.2 November 30, 2021 { id="8.0.2" }
- Fixed #3275: Code annotations always disappear on click
-### 8.0.1 _ November 28, 2021 { id="8.0.1" }
+### 8.0.1 November 28, 2021 { id="8.0.1" }
- Improved rendering of code annotation markers
- Fixed #3265: Wrong margin on nested admonitions
- Fixed wrong `box-sizing` for code annotations in details
-### 8.0.0 _ November 28, 2021 { id="8.0.0" }
+### 8.0.0 November 28, 2021 { id="8.0.0" }
- Added support for code annotations
- Added support for anchor tracking
@@ -384,16 +428,18 @@
- Improved keyboard navigation for footnotes
- Fixed #3214: Search highlighting breaks site when empty
-### 7.3.6 _ October 30, 2021 { id="7.3.6" }
+---
+
+### 7.3.6 October 30, 2021 { id="7.3.6" }
- Added support for adding titles to code blocks
-### 7.3.5 _ October 27, 2021 { id="7.3.5" }
+### 7.3.5 October 27, 2021 { id="7.3.5" }
- Added support for setting table of contents title via `mkdocs.yml`
- Fixed back-to-top button position for right-to-left languages
-### 7.3.4 _ October 17, 2021 { id="7.3.4" }
+### 7.3.4 October 17, 2021 { id="7.3.4" }
- Bumped MkDocs version to 1.2.3 to mitigate [CVE-2021-40978]
- Fixed spacing issues when using integrate table of contents with tabs
@@ -402,7 +448,7 @@
[CVE-2021-40978]: https://nvd.nist.gov/vuln/detail/CVE-2021-40978
-### 7.3.3 _ October 11, 2021 { id="7.3.3" }
+### 7.3.3 October 11, 2021 { id="7.3.3" }
- Rewrite of entire documentation
- Adjusted height of new content tabs to match single line code blocks
@@ -412,7 +458,7 @@
- Fixed new content tabs stealing keyboard access when active
- Fixed some spacings issues for right-to-left languages
-### 7.3.2 _ October 6, 2021 { id="7.3.2" }
+### 7.3.2 October 6, 2021 { id="7.3.2" }
- Deprecated prebuilding of search index
- Improved graceful handling of broken search for `file://`
@@ -421,7 +467,7 @@
- Fixed margin issues when using navigation tabs (7.3.1 regression)
- Fixed search placeholder sometimes being shown too early
-### 7.3.1 _ October 2, 2021 { id="7.3.1" }
+### 7.3.1 October 2, 2021 { id="7.3.1" }
- Added new experimental content tabs implementation
- Fixed #3069: GitHub stats broken for users/orgs (7.1.0 regression)
@@ -431,17 +477,17 @@
- Fixed some spacing issues for right-to-left languages
- Fixed syntax error in Serbian translations
-### 7.3.0 _ September 23, 2021 { id="7.3.0" }
+### 7.3.0 September 23, 2021 { id="7.3.0" }
- Added support for sticky navigation tabs
- Added support for section index pages
- Added support for removing generator notice
-### 7.2.8 _ September 20, 2021 { id="7.2.8" }
+### 7.2.8 September 20, 2021 { id="7.2.8" }
- Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression)
-### 7.2.7 _ September 19, 2021 { id="7.2.7" }
+### 7.2.7 September 19, 2021 { id="7.2.7" }
- Updated Serbian and Serbo-Croatian translations
- Improved appearance of outline on details
@@ -450,115 +496,115 @@
- Fixed back-to-top button being focusable when invisible
- Fixed broken admonition icons (removed in upstream)
-### 7.2.6 _ September 1, 2021 { id="7.2.6" }
+### 7.2.6 September 1, 2021 { id="7.2.6" }
- Fixed rendering of `blockquote` elements (7.0.0 regression)
- Fixed #2973: Custom search worker setting ignored
-### 7.2.5 _ August 25, 2021 { id="7.2.5" }
+### 7.2.5 August 25, 2021 { id="7.2.5" }
- Updated Portuguese translations
- Fixed execution of RxJS teardown logic (7.2.3 regression)
- Fixed #2970: Search results show escaped characters (7.2.2 regression)
-### 7.2.4 _ August 11, 2021 { id="7.2.4" }
+### 7.2.4 August 11, 2021 { id="7.2.4" }
- Fixed #2926: Version selector not working (7.2.3 regression)
- Fixed #2929: Missing CSS class for banner (consistency with Insiders)
-### 7.2.3 _ August 9, 2021 { id="7.2.3" }
+### 7.2.3 August 9, 2021 { id="7.2.3" }
- Slight facelift of data tables, now closer to Material Design
- Fixed instant loading not respecting clicks on search results
- Fixed #2881: Invalid anchor offsets when using instant loading
-### 7.2.2 _ July 31, 2021 { id="7.2.2" }
+### 7.2.2 July 31, 2021 { id="7.2.2" }
- Updated Korean translations
- Fixed #2879: Search highlighting does not properly escape HTML
-### 7.2.1 _ July 25, 2021 { id="7.2.1" }
+### 7.2.1 July 25, 2021 { id="7.2.1" }
- Fixed #2862: Back-to-top button overlays active search bar
-### 7.2.0 _ July 21, 2021 { id="7.2.0" }
+### 7.2.0 July 21, 2021 { id="7.2.0" }
- Added support for search suggestions to save keystrokes
- Added support for search highlighting
- Added support for search sharing (i.e. deep linking)
-### 7.1.11 _ July 18, 2021 { id="7.1.11" }
+### 7.1.11 July 18, 2021 { id="7.1.11" }
- Updated Spanish and Galician translations
-### 7.1.10 _ July 10, 2021 { id="7.1.10" }
+### 7.1.10 July 10, 2021 { id="7.1.10" }
- Refactored appearance of back-to-top button
- Fixed graceful handling of search when browsing locally
-### 7.1.9 _ June 25, 2021 { id="7.1.9" }
+### 7.1.9 June 25, 2021 { id="7.1.9" }
- Improved search language support for Thai and Hindi
- Fixed #2761: License comments lined up at end of file
-### 7.1.8 _ June 12, 2021 { id="7.1.8" }
+### 7.1.8 June 12, 2021 { id="7.1.8" }
- Refactored analytics integration (because of MkDocs 1.2)
- Added support for Google Analytics 4 (`gtag.js`)
- Fixed missing escape for `aria-label` in footer links
-### 7.1.7 _ June 6, 2021 { id="7.1.7" }
+### 7.1.7 June 6, 2021 { id="7.1.7" }
- Improved screen reader support
-### 7.1.6 _ May 30, 2021 { id="7.1.6" }
+### 7.1.6 May 30, 2021 { id="7.1.6" }
- Deprecated `seealso` admonition qualifier
- Added Mongolian and updated Chinese translations
- Fixed #2429: Version selector not touch-friendly on Android devices
- Fixed #2703: Printed 'Initializing search' albeit ready on mobile
-### 7.1.5 _ May 19, 2021 { id="7.1.5" }
+### 7.1.5 May 19, 2021 { id="7.1.5" }
- Fixed #2655: Details breaking page margins on print
-### 7.1.4 _ May 6, 2021 { id="7.1.4" }
+### 7.1.4 May 6, 2021 { id="7.1.4" }
- Added support for git-revision-date-localized plugin creation date
- Improved footnote styles on `:target` and `:focus`
-### 7.1.3 _ April 24, 2021 { id="7.1.3" }
+### 7.1.3 April 24, 2021 { id="7.1.3" }
- Fixed #2586: Empty table of contents shown (7.1.2 regression)
-### 7.1.2 _ April 18, 2021 { id="7.1.2" }
+### 7.1.2 April 18, 2021 { id="7.1.2" }
- Fixed #2554: List markers sometimes overlap floated elements
- Fixed #2563: Adding a class to a `h1` breaks the table of contents
- Fixed #2566: Back-to-top button clickable when invisible
-### 7.1.1 _ April 10, 2021 { id="7.1.1" }
+### 7.1.1 April 10, 2021 { id="7.1.1" }
- Fixed #2501: Nested definition lists compound bottom margin
- Fixed #2508: Switch `extracopyright` block to template variable
- Fixed #2533: Search (and other parts) not working in Safari <14
- Fixed #2538: Visual quirk when opening language selector
-### 7.1.0 _ March 29, 2021 { id="7.1.0" }
+### 7.1.0 March 29, 2021 { id="7.1.0" }
- Added support for back-to-top button
- Added support for color palette toggle
- Added latest release to repository info (GitHub)
- Slight facelift of repository info (lighter fonts, spacing and icons)
-### 7.0.7 _ March 28, 2021 { id="7.0.7" }
+### 7.0.7 March 28, 2021 { id="7.0.7" }
- Updated Hungarian translations
- Fixed #2466: Docker image not based on latest Python and Alpine
- Fixed #2488: Inconsistent header shadow behavior
- Fixed #2492: Inline code blocks in admonition titles missing background
-### 7.0.6 _ March 14, 2021 { id="7.0.6" }
+### 7.0.6 March 14, 2021 { id="7.0.6" }
- Added trailing slash to version selector URL
- Added support for out-of-order anchors in table of contents
@@ -569,7 +615,7 @@
- Fixed version selector to always use version title
- Fixed logo link when using versioning with instant loading
-### 7.0.5 _ March 7, 2021 { id="7.0.5" }
+### 7.0.5 March 7, 2021 { id="7.0.5" }
- Added `extracopyright` block to allow for custom copyright info
- Fixed evaluation of third-party scripts when using instant loading
@@ -578,29 +624,29 @@
- Fixed regression with header title not being updated correctly
- Fixed expanded sections not opening on first click (7.0.4 regression)
-### 7.0.4 _ March 4, 2021 { id="7.0.4" }
+### 7.0.4 March 4, 2021 { id="7.0.4" }
- Added Icelandic translations
- Fixed #2386: Section close requires two clicks (navigation expansion)
- Fixed console error when search is disabled (7.0.0 regression)
- Fixed localsearch integration (7.0.0 regression)
-### 7.0.3 _ February 26, 2021 { id="7.0.3" }
+### 7.0.3 February 26, 2021 { id="7.0.3" }
- Fixed JavaScript errors in older browsers (target ES2020 -> ES2015)
-### 7.0.2 _ February 25, 2021 { id="7.0.2" }
+### 7.0.2 February 25, 2021 { id="7.0.2" }
- Fixed #2343: Invalid source map URLs for JS and CSS files
- Fixed #2347: Version selector missing when using versioning
-### 7.0.1 _ February 24, 2021 { id="7.0.1" }
+### 7.0.1 February 24, 2021 { id="7.0.1" }
- Fixed #2334: Google Analytics triggers page view twice (7.0.0 regression)
- Fixed #2336: Details bleed into inline admonitions
- Fixed #2337: Images don't align correctly (7.0.0 regression)
-### 7.0.0 _ February 22, 2021 { id="7.0.0" }
+### 7.0.0 February 22, 2021 { id="7.0.0" }
- Added support for deploying multiple versions
- Added support for integrating a language selector
@@ -609,45 +655,45 @@
- Removed Webpack in favor of reactive build strategy (-480 dependencies)
- Fixed keyboard navigation for code blocks after content tabs switch
-### 6.2.8 _ February 4, 2021 { id="6.2.8" }
+### 6.2.8 February 4, 2021 { id="6.2.8" }
- Updated Japanese and Polish translations
- Fixed #2261: Print dialog auto-closing when using instant loading
-### 6.2.7 _ January 31, 2021 { id="6.2.7" }
+### 6.2.7 January 31, 2021 { id="6.2.7" }
- Fixed #2251: Updated Docker image to latest Alpine Linux
-### 6.2.6 _ January 26, 2021 { id="6.2.6" }
+### 6.2.6 January 26, 2021 { id="6.2.6" }
- Added Bulgarian translations
- Fixed #2233: Search not shown when using header autohiding
-### 6.2.5 _ January 17, 2021 { id="6.2.5" }
+### 6.2.5 January 17, 2021 { id="6.2.5" }
- Fixed syntax error in Swedish translations
- Optimized navigation partials to improve build speed for huge docs
-### 6.2.4 _ January 9, 2021 { id="6.2.4" }
+### 6.2.4 January 9, 2021 { id="6.2.4" }
- Fixed #2156: Missing syntax highlighting for binary numbers
- Fixed #2186: Disqus showing on 404 page
-### 6.2.3 _ December 27, 2020 { id="6.2.3" }
+### 6.2.3 December 27, 2020 { id="6.2.3" }
- Added back hidden overflow on root container
- Fixed #2142: MathJax formulas sometimes have vertical scrollbars
-### 6.2.2 _ December 22, 2020 { id="6.2.2" }
+### 6.2.2 December 22, 2020 { id="6.2.2" }
- Removed Markdown version range limit (6.2.0 regression)
-### 6.2.1 _ December 22, 2020 { id="6.2.1" }
+### 6.2.1 December 22, 2020 { id="6.2.1" }
- Fixed all import and asset paths in templates (6.2.0 regression)
- Downgraded webpack-asset-manifest-plugin - broke all asset paths
-### 6.2.0 _ December 22, 2020 { id="6.2.0" }
+### 6.2.0 December 22, 2020 { id="6.2.0" }
- Added support for navigation sections
- Added support for navigation expansion
@@ -661,52 +707,52 @@
- Improved appearance for horizontal rulers
- Improved Spanish and Swedish translations
-### 6.1.7 _ December 6, 2020 { id="6.1.7" }
+### 6.1.7 December 6, 2020 { id="6.1.7" }
- Fixed #2081: Fixed stats for private GitHub repositories
- Fixed alignment for admonition icon alignment for right-to-left languages
-### 6.1.6 _ November 22, 2020 { id="6.1.6" }
+### 6.1.6 November 22, 2020 { id="6.1.6" }
- Fixed #2048: Math formulas show scrollbars (Windows)
-### 6.1.5 _ November 15, 2020 { id="6.1.5" }
+### 6.1.5 November 15, 2020 { id="6.1.5" }
- Fixed search reset button not showing/hiding correctly
-### 6.1.4 _ November 7, 2020 { id="6.1.4" }
+### 6.1.4 November 7, 2020 { id="6.1.4" }
- Fixed sidebar jitter when scrolling footer into view
-### 6.1.3 _ November 5, 2020 { id="6.1.3" }
+### 6.1.3 November 5, 2020 { id="6.1.3" }
- Added support for keywords `meta` tag
- Fixed #2027: Line numbers don't scale with smaller font size
- Fixed link colors for black and white on `slate` color scheme
- Removed focus outline on scrolling code blocks for pointer devices
-### 6.1.2 _ October 31, 2020 { id="6.1.2" }
+### 6.1.2 October 31, 2020 { id="6.1.2" }
- Fixed sizing of icons in admonitions, task lists, etc. (6.1.1 regression)
-### 6.1.1 _ October 31, 2020 { id="6.1.1" }
+### 6.1.1 October 31, 2020 { id="6.1.1" }
- Fixed #2019: Page title not correctly updated when using instant loading
-### 6.1.0 _ October 17, 2020 { id="6.1.0" }
+### 6.1.0 October 17, 2020 { id="6.1.0" }
- Fixed #1973: Added support for printing in dark mode
- Fixed #1974: Added support for printing content tabs
- Fixed #1995: Improved customizability of details extension
-### 6.0.2 _ October 4, 2020 { id="6.0.2" }
+### 6.0.2 October 4, 2020 { id="6.0.2" }
- Added Georgian translations
- Added escaping for link `title` attributes where necessary
- Fixed #1956: Pages with whitespace in names have invalid links in search
- Removed unnecessary (duplicated) link `title` attributes
-### 6.0.1 _ September 26, 2020 { id="6.0.1" }
+### 6.0.1 September 26, 2020 { id="6.0.1" }
- Fixed stemmer support for `file://` protocol through `iframe-worker`
- Fixed details marker showing for search result in Firefox
@@ -715,7 +761,7 @@
- Reduced size of JavaScript by 30% (`176kb` → `124kb`)
- Removed `mkdocs` and `readthedocs` themes from Docker image
-### 6.0.0 _ September 25, 2020 { id="6.0.0" }
+### 6.0.0 September 25, 2020 { id="6.0.0" }
- Improved search result look and feel
- Improved search result stability while typing
@@ -727,34 +773,36 @@
- Removed hero partial in favor of custom implementation
- Removed deprecated front matter features
-### 5.5.14 _ September 23, 2020 { id="5.5.14" }
+---
+
+### 5.5.14 September 23, 2020 { id="5.5.14" }
- Improved spacing around image captions
- Fixed #1939: Long tables cause header overlap in print view
-### 5.5.13 _ September 19, 2020 { id="5.5.13" }
+### 5.5.13 September 19, 2020 { id="5.5.13" }
- Improved abbreviations on touch devices
-### 5.5.12 _ August 31, 2020 { id="5.5.12" }
+### 5.5.12 August 31, 2020 { id="5.5.12" }
- Fixed #1638: occasional `404` for images when using instant loading
-### 5.5.11 _ August 28, 2020 { id="5.5.11" }
+### 5.5.11 August 28, 2020 { id="5.5.11" }
- Fixed Disqus integration, as the minifier killed the config
-### 5.5.10 _ August 28, 2020 { id="5.5.10" }
+### 5.5.10 August 28, 2020 { id="5.5.10" }
- Improved rendering by moving Disqus integration after page load
- Fixed #1887: Moved navigation icons to CSS to reduce size of HTML
-### 5.5.9 _ August 26, 2020 { id="5.5.9" }
+### 5.5.9 August 26, 2020 { id="5.5.9" }
- Added Esperanto translations
- Fixed #1884: External links not included in navigation tabs
-### 5.5.8 _ August 23, 2020 { id="5.5.8" }
+### 5.5.8 August 23, 2020 { id="5.5.8" }
- Removed focus outline on `details` and content tabs for pointer devices
- Improved accessibility of content tabs (now navigable via arrow keys)
@@ -762,29 +810,29 @@
- Fixed some memleaks in observable subscriptions
- Fixed color definitions for `theme-color` meta tag
-### 5.5.7 _ August 16, 2020 { id="5.5.7" }
+### 5.5.7 August 16, 2020 { id="5.5.7" }
- Improved contrast ratio to 4.5:1 for syntax highlighting
- Improved contrast ratio to 4.5:1 for table of contents
-### 5.5.6 _ August 12, 2020 { id="5.5.6" }
+### 5.5.6 August 12, 2020 { id="5.5.6" }
- Switched base template for `404.html` to `main.html`
- Fixed #1864: GitHub organisation stats not loading
-### 5.5.5 _ August 11, 2020 { id="5.5.5" }
+### 5.5.5 August 11, 2020 { id="5.5.5" }
- Fixed missing vendor and worker distribution files
-### 5.5.4 _ August 11, 2020 { id="5.5.4" }
+### 5.5.4 August 11, 2020 { id="5.5.4" }
- Added support for sortable data tables
-### 5.5.3 _ August 4, 2020 { id="5.5.3" }
+### 5.5.3 August 4, 2020 { id="5.5.3" }
- Fixed search for languages other than English (5.5.1 regression)
-### 5.5.2 _ August 3, 2020 { id="5.5.2" }
+### 5.5.2 August 3, 2020 { id="5.5.2" }
- Improved highlight colors and spacing for `ins`, `del` and `mark`
- Changed some keyboard symbols for better equivalents
@@ -793,14 +841,14 @@
- Fixed too small content tab labels (5.5.1 regression)
- Fixed icon repeating for custom admonition icons
-### 5.5.1 _ August 1, 2020 { id="5.5.1" }
+### 5.5.1 August 1, 2020 { id="5.5.1" }
- Improved typesetting by basing `font-size` and spacings on `em`
- Improved print view by slightly scaling down `font-size`
- Changed custom site title (metadata) to be suffixed with site name
- Fixed top- and bottom spacing of paragraphs inside table cells
-### 5.5.0 _ July 24, 2020 { id="5.5.0" }
+### 5.5.0 July 24, 2020 { id="5.5.0" }
- Rewrite of entire documentation
- Rewrite of syntax highlighting to be customizable with CSS variables
@@ -813,70 +861,70 @@
- Fixed top margin for tabbed content when using a JavaScript highlighter
- Deprecated metadata-based redirects, source links and heroes
-### 5.4.0 _ June 29, 2020 { id="5.4.0" }
+### 5.4.0 June 29, 2020 { id="5.4.0" }
- Added support to wrap searches in quotes to switch from `OR` to `AND`
- Fixed highlighting of numbers in search results
-### 5.3.3 _ June 24, 2020 { id="5.3.3" }
+### 5.3.3 June 24, 2020 { id="5.3.3" }
- Added Bengali translations
- Fixed #1773: Search for numbers does not return any result (regression)
-### 5.3.2 _ June 21, 2020 { id="5.3.2" }
+### 5.3.2 June 21, 2020 { id="5.3.2" }
- Improved search typeahead experience with non-Latin characters
- Fixed #1753: Japanese search doesn't work anymore
-### 5.3.1 _ June 20, 2020 { id="5.3.1" }
+### 5.3.1 June 20, 2020 { id="5.3.1" }
- Fixed #1761: Duplication of search worker when subscribing to observable
-### 5.3.0 _ June 15, 2020 { id="5.3.0" }
+### 5.3.0 June 15, 2020 { id="5.3.0" }
- Added support for color schemes based on user preference
- Fixed #1755: Tokenizer separator setting ignored
-### 5.2.3 _ June 6, 2020 { id="5.2.3" }
+### 5.2.3 June 6, 2020 { id="5.2.3" }
- Improved search typeahead behavior for some languages (`de`, `fr`, ...)
- Improved styles for scrollbars on Firefox
- Fixed #1741: Removed `preconnect` hint for Google Analytics
-### 5.2.2 _ May 26, 2020 { id="5.2.2" }
+### 5.2.2 May 26, 2020 { id="5.2.2" }
- Fixed #1728: Legacy Edge doesn't support `deg` values in `hsla` colors
-### 5.2.1 _ May 22, 2020 { id="5.2.1" }
+### 5.2.1 May 22, 2020 { id="5.2.1" }
- Fixed color of links in table headers, e.g. footnotes
- Fixed color scheme not being applied without primary or accent color
- Fixed hover delay for links inside code blocks
-### 5.2.0 _ May 18, 2020 { id="5.2.0" }
+### 5.2.0 May 18, 2020 { id="5.2.0" }
- Added color schemes implementation + dark mode
- Fixed #1583: Missing option for separate link colors
-### 5.1.7 _ May 16, 2020 { id="5.1.7" }
+### 5.1.7 May 16, 2020 { id="5.1.7" }
- Added keyboard focus support for overflowing code blocks
- Fixed #1696: Infinite loop in some cases when using instant loading
-### 5.1.6 _ May 9, 2020 { id="5.1.6" }
+### 5.1.6 May 9, 2020 { id="5.1.6" }
- Added Burmese translations
- Added general anchor offset solution using `scroll-margin-top`
- Fixed #1653: Instant loading shouldn't intercept links to `*.html` files
-### 5.1.5 _ May 3, 2020 { id="5.1.5" }
+### 5.1.5 May 3, 2020 { id="5.1.5" }
- Added `name` attribute for social links to set link `title`
- Fixed #1623: Allow arbitrary links in social links
- Fixed #1664: Height of `iframe` is not adjustable
- Fixed #1667: Sidebars are scrolled to bottom on load (bug in Chrome 81+)
-### 5.1.4 _ April 30, 2020 { id="5.1.4" }
+### 5.1.4 April 30, 2020 { id="5.1.4" }
- Switched to [@mdi/svg] Material Design icon package
- Fixed #1655: Navigation may disappear after switching viewports
@@ -886,11 +934,11 @@
[@mdi/svg]: https://github.com/Templarian/MaterialDesign-SVG
-### 5.1.3 _ April 26, 2020 { id="5.1.3" }
+### 5.1.3 April 26, 2020 { id="5.1.3" }
- Fixed overflowing content area after switch to flexbox
-### 5.1.2 _ April 26, 2020 { id="5.1.2" }
+### 5.1.2 April 26, 2020 { id="5.1.2" }
- Added status information to search observable
- Added status information to search modal
@@ -900,31 +948,31 @@
- Fixed re-submission of query after search is initialized
- Fixed jitter of sidebars on all browsers by switching to `sticky`
-### 5.1.1 _ April 17, 2020 { id="5.1.1" }
+### 5.1.1 April 17, 2020 { id="5.1.1" }
- Added new FontAwesome icons
- Fixed #1609: Instant loading doesn't honor `target=_blank`
- Fixed GitHub stars count rounding errors
- Fixed GitLab stars count retrieval
-### 5.1.0 _ April 12, 2020 { id="5.1.0" }
+### 5.1.0 April 12, 2020 { id="5.1.0" }
- Added support for icons from Markdown through [mkdocs-material-extensions]
[mkdocs-material-extensions]: https://github.com/facelessuser/mkdocs-material-extensions
-### 5.0.2 _ April 10, 2020 { id="5.0.2" }
+### 5.0.2 April 10, 2020 { id="5.0.2" }
- Added CSS source maps to distribution files
- Fixed errors in Chinese (Traditional) translations
- Fixed creation of stale directory on installation from git
- Improved overflow scrolling behavior on iOS (reduced bundle size by `4kb`)
-### 5.0.1 _ April 7, 2020 { id="5.0.1" }
+### 5.0.1 April 7, 2020 { id="5.0.1" }
- Fixed syntax error in Spanish translation
-### 5.0.0 _ April 7, 2020 { id="5.0.0" }
+### 5.0.0 April 7, 2020 { id="5.0.0" }
- Reactive architecture – try `app.dialog$.next("Hi!")` in the console
- Instant loading – make Material behave like a Single Page Application
@@ -941,17 +989,17 @@
- Reduced HTML and CSS footprint due to deprecation of Internet Explorer support
- Slight facelifting of some UI elements (admonitions, tables, ...)
-### 4.6.3 _ February 14, 2020 { id="4.6.3" }
+### 4.6.3 February 14, 2020 { id="4.6.3" }
- Removed optional third-party plugins from `requirements.txt`
- Updated Docker image to contain all supported third-party plugins
-### 4.6.2 _ February 8, 2020 { id="4.6.2" }
+### 4.6.2 February 8, 2020 { id="4.6.2" }
- Added Romanian translations
- Fixed #1451: Inconsistent spacing for fenced code blocks
-### 4.6.1 _ February 8, 2020 { id="4.6.1" }
+### 4.6.1 February 8, 2020 { id="4.6.1" }
- Fixed #1324: Metadata author only rendering first character
- Fixed #1393: Set `tabindex` to `0` for skip to content link
@@ -959,90 +1007,90 @@
- Fixed errors in Japanese translations
- Improved Google Lighthouse score
-### 4.6.0 _ December 11, 2019 { id="4.6.0" }
+### 4.6.0 December 11, 2019 { id="4.6.0" }
- Added support for [git-revision-date-localized-plugin]
- Fixed invalid character in Google Fonts URL
[git-revision-date-localized-plugin]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
-### 4.5.1 _ December 2, 2019 { id="4.5.1" }
+### 4.5.1 December 2, 2019 { id="4.5.1" }
- Added Thai translations
- Fixed missing assets in GitHub release `.zip` and `.tar.gz`
-### 4.5.0 _ November 16, 2019 { id="4.5.0" }
+### 4.5.0 November 16, 2019 { id="4.5.0" }
- Fixed #1330: Upgraded EmojiOne to Tweomji due to licensing issues
- Fixed #1339: Temporarily pinned PyMdown and Markdown due to
- Fixed errors in Greek translations
- Improved GitHub statistics retrieval
-### 4.4.3 _ October 3, 2019 { id="4.4.3" }
+### 4.4.3 October 3, 2019 { id="4.4.3" }
- Added Estonian translations
- Fixed removal of copyright banners in minified JavaScript
- Removed unnecessary title attributes from links in table of contents
-### 4.4.2 _ August 27, 2019 { id="4.4.2" }
+### 4.4.2 August 27, 2019 { id="4.4.2" }
- Added Afrikaans translations
- Fixed broken page title when `h1` contained HTML tags
- Improved accessibility for IE users
- Removed unnecessary `title` attributes from links in navigation
-### 4.4.1 _ August 22, 2019 { id="4.4.1" }
+### 4.4.1 August 22, 2019 { id="4.4.1" }
- Added support for `black` as a primary color
- Fixed broken footer bar when `h1` contained HTML tags
-### 4.4.0 _ June 15, 2019 { id="4.4.0" }
+### 4.4.0 June 15, 2019 { id="4.4.0" }
- Added Slovenian translations
- Reverted template minification in favor of `mkdocs-minify-plugin`
- Fixed #1114: Tabs don't reappear when default `font-size` is smaller than `16`
-### 4.3.1 _ May 23, 2019 { id="4.3.1" }
+### 4.3.1 May 23, 2019 { id="4.3.1" }
- Fixed spelling error in Danish translations
-### 4.3.0 _ May 17, 2019 { id="4.3.0" }
+### 4.3.0 May 17, 2019 { id="4.3.0" }
- Added support for changing header through metadata title property
- Added `font-display: swap` to Google Font loading logic
- Removed whitespace from templates, saving `4kb` (`.7kb` gzipped) per request
- Fixed alignment of repository icons on tablet and desktop
-### 4.2.0 _ April 28, 2019 { id="4.2.0" }
+### 4.2.0 April 28, 2019 { id="4.2.0" }
- Added Norwegian (Nynorsk) translations
- Fixed loss of focus in non-form input elements due to search hotkeys
- Fixed #1067: Search hotkeys not working for mobile/tablet screensize
- Fixed #1068: Search not correctly aligned for tablet screensize
-### 4.1.2 _ April 16, 2019 { id="4.1.2" }
+### 4.1.2 April 16, 2019 { id="4.1.2" }
- Fixed #1072: HTML tags appearing in navigation link titles
-### 4.1.1 _ March 28, 2019 { id="4.1.1" }
+### 4.1.1 March 28, 2019 { id="4.1.1" }
- Fixed minor CSS errors detected during validation
-### 4.1.0 _ March 22, 2019 { id="4.1.0" }
+### 4.1.0 March 22, 2019 { id="4.1.0" }
- Fixed #1023: Search for Asian languages broken after Lunr.js update
- Fixed #1026: contenteditable elements loose focus on hotkeys
-### 4.0.2 _ March 1, 2019 { id="4.0.2" }
+### 4.0.2 March 1, 2019 { id="4.0.2" }
- Fixed #1012: HTML character entities appear in search result titles
-### 4.0.1 _ February 13, 2019 { id="4.0.1" }
+### 4.0.1 February 13, 2019 { id="4.0.1" }
- Fixed #762, #816: Glitch in sidebar when collapsing items
- Fixed #869: Automatically expand details before printing
-### 4.0.0 _ February 13, 2019 { id="4.0.0" }
+### 4.0.0 February 13, 2019 { id="4.0.0" }
- Added background on hover for table rows
- Removed Google Tag Manager and reverted to Google Analytics
@@ -1050,81 +1098,85 @@
- Fixed #911: Chrome breaks layout if system language is Chinese (**BREAKING**)
- Fixed #976: Removed FastClick
-### 3.3.0 _ January 29, 2019 { id="3.3.0" }
+---
+
+### 3.3.0 January 29, 2019 { id="3.3.0" }
- Moved Google Analytics integration into `head` using Google Tag Manager
- Fixed #972: Unicode slugifier breaks table of contents blur on scroll
- Fixed #974: Additional links in table of contents break blur on scroll
-### 3.2.0 _ December 28, 2018 { id="3.2.0" }
+### 3.2.0 December 28, 2018 { id="3.2.0" }
- Added support for redirects using metadata refresh
- Fixed #921: Load Google Analytics snippet asynchronously
-### 3.1.0 _ November 17, 2018 { id="3.1.0" }
+### 3.1.0 November 17, 2018 { id="3.1.0" }
- Added support for Progressive Web App Manifest
- Fixed #915: Search bug in Safari (upgraded Lunr.js)
-### 3.0.6 _ October 26, 2018 { id="3.0.6" }
+### 3.0.6 October 26, 2018 { id="3.0.6" }
- Added Taiwanese translations
- Fixed #906: JavaScript code blocks evaluated in search results
-### 3.0.5 _ October 23, 2018 { id="3.0.5" }
+### 3.0.5 October 23, 2018 { id="3.0.5" }
- Added Croatian and Indonesian translations
- Fixed #899: Skip-to-content link invalid from 2nd level on
- Fixed #902: Missing URL filter in footer for FontAwesome link
-### 3.0.4 _ September 3, 2018 { id="3.0.4" }
+### 3.0.4 September 3, 2018 { id="3.0.4" }
- Updated Dutch translations
- Fixed #856: Removed preconnect meta tag if Google Fonts are disabled
-### 3.0.3 _ August 7, 2018 { id="3.0.3" }
+### 3.0.3 August 7, 2018 { id="3.0.3" }
- Fixed #841: Additional path levels for extra CSS and JS
-### 3.0.2 _ August 6, 2018 { id="3.0.2" }
+### 3.0.2 August 6, 2018 { id="3.0.2" }
- Fixed #839: Lunr.js stemmer imports incorrect
-### 3.0.1 _ August 5, 2018 { id="3.0.1" }
+### 3.0.1 August 5, 2018 { id="3.0.1" }
- Fixed #838: Search result links incorrect
-### 3.0.0 _ August 5, 2018 { id="3.0.0" }
+### 3.0.0 August 5, 2018 { id="3.0.0" }
- Upgraded MkDocs to 1.0 (**BREAKING**)
- Upgraded Python in official Docker image to 3.6
- Added Serbian and Serbo-Croatian translations
-### 2.9.4 _ July 29, 2018 { id="2.9.4" }
+---
+
+### 2.9.4 July 29, 2018 { id="2.9.4" }
- Fixed build error after MkDocs upgrade
-### 2.9.3 _ July 29, 2018 { id="2.9.3" }
+### 2.9.3 July 29, 2018 { id="2.9.3" }
- Added link to home for logo in drawer
- Fixed dependency problems between MkDocs and Tornado
-### 2.9.2 _ June 29, 2018 { id="2.9.2" }
+### 2.9.2 June 29, 2018 { id="2.9.2" }
- Added Hindi and Czech translations
-### 2.9.1 _ June 18, 2018 { id="2.9.1" }
+### 2.9.1 June 18, 2018 { id="2.9.1" }
- Added support for different spellings for theme color
- Fixed #799: Added support for webfont minification in production
- Fixed #800: Added `.highlighttable` as an alias for `.codehilitetable`
-### 2.9.0 _ June 13, 2018 { id="2.9.0" }
+### 2.9.0 June 13, 2018 { id="2.9.0" }
- Added support for theme color on Android
- Fixed #796: Rendering of nested tabbed code blocks
-### 2.8.0 _ June 10, 2018 { id="2.8.0" }
+### 2.8.0 June 10, 2018 { id="2.8.0" }
- Added support for grouping code blocks with tabs
- Added Material and FontAwesome icon fonts to distribution files (GDPR)
@@ -1132,35 +1184,35 @@
- Added Slovak translations
- Fixed #790: Prefixed `id` attributes with `__` to avoid name clashes
-### 2.7.3 _ April 26, 2018 { id="2.7.3" }
+### 2.7.3 April 26, 2018 { id="2.7.3" }
- Added Finnish translations
-### 2.7.2 _ April 9, 2018 { id="2.7.2" }
+### 2.7.2 April 9, 2018 { id="2.7.2" }
- Fixed rendering issue for `details` on Edge
-### 2.7.1 _ March 21, 2018 { id="2.7.1" }
+### 2.7.1 March 21, 2018 { id="2.7.1" }
- Added Galician translations
- Fixed #730: Scroll chasing error on home page if Disqus is enabled
- Fixed #736: Reset drawer and search upon back button invocation
-### 2.7.0 _ March 6, 2018 { id="2.7.0" }
+### 2.7.0 March 6, 2018 { id="2.7.0" }
- Added ability to set absolute URL for logo
- Added Hebrew translations
-### 2.6.6 _ February 22, 2018 { id="2.6.6" }
+### 2.6.6 February 22, 2018 { id="2.6.6" }
- Added preconnect for Google Fonts for faster loading
- Fixed #710: With tabs sidebar disappears if JavaScript is not available
-### 2.6.5 _ February 22, 2018 { id="2.6.5" }
+### 2.6.5 February 22, 2018 { id="2.6.5" }
- Reverted `--dev-addr` flag removal from `Dockerfile`
-### 2.6.4 _ February 21, 2018 { id="2.6.4" }
+### 2.6.4 February 21, 2018 { id="2.6.4" }
- Added Catalan translations
- Fixed incorrect margins for buttons in Firefox and Safari
@@ -1168,24 +1220,24 @@
- Reverted GitHub stars rounding method
- Removed `--dev-addr` flag from `Dockerfile` for Windows compatibility
-### 2.6.3 _ February 18, 2018 { id="2.6.3" }
+### 2.6.3 February 18, 2018 { id="2.6.3" }
- Added Vietnamese translations
-### 2.6.2 _ February 12, 2018 { id="2.6.2" }
+### 2.6.2 February 12, 2018 { id="2.6.2" }
- Added Arabic translations
- Fixed incorrect rounding of amount of GitHub stars
- Fixed double-layered borders for tables
-### 2.6.1 _ February 11, 2018 { id="2.6.1" }
+### 2.6.1 February 11, 2018 { id="2.6.1" }
- Added ability to override Disqus integration using metadata
- Fixed #690: Duplicate slashes in source file URLs
- Fixed #696: Active page highlight not working with default palette
- Adjusted German translations
-### 2.6.0 _ February 2, 2018 { id="2.6.0" }
+### 2.6.0 February 2, 2018 { id="2.6.0" }
- Moved default search configuration to default translation (English)
- Added support to automatically set text direction from translation
@@ -1195,35 +1247,35 @@
- Fixed support for Polish search
- Fixed disappearing GitHub, GitLab and Bitbucket repository icons
-### 2.5.5 _ January 31, 2018 { id="2.5.5" }
+### 2.5.5 January 31, 2018 { id="2.5.5" }
- Added Hungarian translations
-### 2.5.4 _ January 29, 2018 { id="2.5.4" }
+### 2.5.4 January 29, 2018 { id="2.5.4" }
- Fixed #683: `gh-deploy` fails inside Docker
-### 2.5.3 _ January 25, 2018 { id="2.5.3" }
+### 2.5.3 January 25, 2018 { id="2.5.3" }
- Added Ukrainian translations
-### 2.5.2 _ January 22, 2018 { id="2.5.2" }
+### 2.5.2 January 22, 2018 { id="2.5.2" }
- Added default search language mappings for all localizations
- Fixed #673: Error loading non-existent search language
- Fixed #675: Uncaught reference error when search plugin disabled
-### 2.5.1 _ January 20, 2018 { id="2.5.1" }
+### 2.5.1 January 20, 2018 { id="2.5.1" }
- Fixed permalink for main headline
- Improved missing translation handling with English as a fallback
- Improved accessibility with skip-to-content link
-### 2.5.0 _ January 13, 2018 { id="2.5.0" }
+### 2.5.0 January 13, 2018 { id="2.5.0" }
- Added support for right-to-left languages
-### 2.4.0 _ January 11, 2018 { id="2.4.0" }
+### 2.4.0 January 11, 2018 { id="2.4.0" }
- Added focus state for clipboard buttons
- Fixed #400: Search bar steals tab focus
@@ -1236,55 +1288,55 @@
- Removed `outline` resets for links
- Improved general tabbing behavior on desktop
-### 2.3.0 _ January 9, 2018 { id="2.3.0" }
+### 2.3.0 January 9, 2018 { id="2.3.0" }
- Added `example` (synonym: `snippet`) style for admonitions
- Added synonym `abstract` for `summary` style for admonitions
-### 2.2.6 _ December 27, 2017 { id="2.2.6" }
+### 2.2.6 December 27, 2017 { id="2.2.6" }
- Added Turkish translations
- Fixed unclickable area below header in case JavaScript is not available
-### 2.2.5 _ December 18, 2017 { id="2.2.5" }
+### 2.2.5 December 18, 2017 { id="2.2.5" }
- Fixed #639: Broken default favicon
-### 2.2.4 _ December 18, 2017 { id="2.2.4" }
+### 2.2.4 December 18, 2017 { id="2.2.4" }
- Fixed #638: Build breaks with Jinja < 2.9
-### 2.2.3 _ December 13, 2017 { id="2.2.3" }
+### 2.2.3 December 13, 2017 { id="2.2.3" }
- Fixed #630: Admonition sets padding on any last child
- Adjusted Chinese (Traditional) translations
-### 2.2.2 _ December 8, 2017 { id="2.2.2" }
+### 2.2.2 December 8, 2017 { id="2.2.2" }
- Added Dutch translations
- Adjusted targeted link and footnote offsets
- Simplified admonition styles and fixed padding bug
-### 2.2.1 _ December 2, 2017 { id="2.2.1" }
+### 2.2.1 December 2, 2017 { id="2.2.1" }
- Fixed #616: Minor styling error with title-only admonitions
- Removed border for table of contents and improved spacing
-### 2.2.0 _ November 22, 2017 { id="2.2.0" }
+### 2.2.0 November 22, 2017 { id="2.2.0" }
- Added support for hero teaser
- Added Portuguese translations
- Fixed #586: Footnote backref target offset regression
- Fixed #605: Search stemmers not correctly loaded
-### 2.1.1 _ November 21, 2017 { id="2.1.1" }
+### 2.1.1 November 21, 2017 { id="2.1.1" }
- Replaced deprecated `babel-preset-es2015` with `babel-preset-env`
- Refactored Gulp build pipeline with Webpack
- Removed right border on sidebars
- Fixed broken color transition on header
-### 2.1.0 _ November 19, 2017 { id="2.1.0" }
+### 2.1.0 November 19, 2017 { id="2.1.0" }
- Added support for `white` as a primary color
- Added support for sliding site name and title
@@ -1294,17 +1346,17 @@
- Improved CSS customizability by leveraging inheritance
- Removed scroll shadows via `background-attachment`
-### 2.0.4 _ November 5, 2017 { id="2.0.4" }
+### 2.0.4 November 5, 2017 { id="2.0.4" }
- Fixed `details` not opening with footnote reference
-### 2.0.3 _ November 5, 2017 { id="2.0.3" }
+### 2.0.3 November 5, 2017 { id="2.0.3" }
- Added Japanese translations
- Fixed #540: Jumping to anchor inside `details` doesn't open it
- Fixed active link colors in footer
-### 2.0.2 _ November 1, 2017 { id="2.0.2" }
+### 2.0.2 November 1, 2017 { id="2.0.2" }
- Added Russian translations
- Fixed #542: Horizontal scrollbar between `1220px` and `1234px`
@@ -1312,62 +1364,64 @@
- Fixed #558: Flash of unstyled content
- Fixed favicon regression caused by deprecation upstream
-### 2.0.1 _ October 31, 2017 { id="2.0.1" }
+### 2.0.1 October 31, 2017 { id="2.0.1" }
- Fixed error when initializing search
- Fixed styles for link to edit the current page
- Fixed styles on nested admonition in details
-### 2.0.0 _ October 31, 2017 { id="2.0.0" }
+### 2.0.0 October 31, 2017 { id="2.0.0" }
- Upgraded MkDocs to 0.17.1 (__BREAKING__)
- Added support for easier configuration of search tokenizer
- Added support to disable search
- Added Korean translations
-### 1.12.2 _ October 26, 2017 { id="1.12.2" }
+---
+
+### 1.12.2 October 26, 2017 { id="1.12.2" }
- Added Italian, Norwegian, French and Chinese translations
-### 1.12.1 _ October 22, 2017 { id="1.12.1" }
+### 1.12.1 October 22, 2017 { id="1.12.1" }
- Added Polish, Swedish and Spanish translations
- Improved downward compatibility with custom partials
- Temporarily pinned MkDocs version within Docker image to 0.16.3
- Fixed #519: Missing theme configuration file
-### 1.12.0 _ October 20, 2017 { id="1.12.0" }
+### 1.12.0 October 20, 2017 { id="1.12.0" }
- Added support for setting language(s) via `mkdocs.yml`
- Added support for default localization
- Added German and Danish translations
- Fixed #374: Search bar misalignment on big screens
-### 1.11.0 _ October 19, 2017 { id="1.11.0" }
+### 1.11.0 October 19, 2017 { id="1.11.0" }
- Added localization to clipboard
- Refactored localization logic
-### 1.10.4 _ October 18, 2017 { id="1.10.4" }
+### 1.10.4 October 18, 2017 { id="1.10.4" }
- Improved print styles of code blocks
- Improved search UX (don't close on enter if no selection)
- Fixed #495: Vertical scrollbar on short pages
-### 1.10.3 _ October 11, 2017 { id="1.10.3" }
+### 1.10.3 October 11, 2017 { id="1.10.3" }
- Fixed #484: Vertical scrollbar on some MathJax formulas
- Fixed #483: Footnote backref target offset regression
-### 1.10.2 _ October 6, 2017 { id="1.10.2" }
+### 1.10.2 October 6, 2017 { id="1.10.2" }
- Fixed #468: Sidebar shows scrollbar if content is shorter (in Safari)
-### 1.10.1 _ September 14, 2017 { id="1.10.1" }
+### 1.10.1 September 14, 2017 { id="1.10.1" }
- Fixed #455: Bold code blocks rendered with normal font weight
-### 1.10.0 _ September 1, 2017 { id="1.10.0" }
+### 1.10.0 September 1, 2017 { id="1.10.0" }
- Added support to make logo default icon configurable
- Fixed uninitialized overflow scrolling on main pane for iOS
@@ -1375,7 +1429,7 @@
- Fixed incorrect color transition for nested panes in mobile navigation
- Improved checkbox styles for Tasklist from PyMdown Extension package
-### 1.9.0 _ August 29, 2017 { id="1.9.0" }
+### 1.9.0 August 29, 2017 { id="1.9.0" }
- Added `info` (synonym: `todo`) style for admonitions
- Added `question` (synonym: `help`, `faq`) style for admonitions
@@ -1385,58 +1439,58 @@
- Replaced ligatures with Unicode code points to avoid broken layout
- Upgraded PyMdown Extensions package dependency to >= 3.4
-### 1.8.1 _ August 7, 2017 { id="1.8.1" }
+### 1.8.1 August 7, 2017 { id="1.8.1" }
- Fixed #421: Missing pagination for GitHub API
-### 1.8.0 _ August 2, 2017 { id="1.8.0" }
+### 1.8.0 August 2, 2017 { id="1.8.0" }
- Added support for lazy-loading of search results for better performance
- Added support for customization of search tokenizer/separator
- Fixed #424: Search doesn't handle capital letters anymore
- Fixed #419: Search doesn't work on whole words
-### 1.7.5 _ July 25, 2017 { id="1.7.5" }
+### 1.7.5 July 25, 2017 { id="1.7.5" }
- Fixed #398: Forms broken due to search shortcuts
- Improved search overall user experience
- Improved search matching and highlighting
- Improved search accessibility
-### 1.7.4 _ June 21, 2017 { id="1.7.4" }
+### 1.7.4 June 21, 2017 { id="1.7.4" }
- Fixed functional link colors in table of contents for active palette
- Fixed #368: Compatibility issues with IE11
-### 1.7.3 _ June 7, 2017 { id="1.7.3" }
+### 1.7.3 June 7, 2017 { id="1.7.3" }
- Fixed error when setting language to Japanese for site search
-### 1.7.2 _ June 6, 2017 { id="1.7.2" }
+### 1.7.2 June 6, 2017 { id="1.7.2" }
- Fixed offset of search box when `repo_url` is not set
- Fixed non-disappearing tooltip
-### 1.7.1 _ June 1, 2017 { id="1.7.1" }
+### 1.7.1 June 1, 2017 { id="1.7.1" }
- Fixed wrong `z-index` order of header, overlay and drawer
- Fixed wrong offset of targeted footnote back references
-### 1.7.0 _ June 1, 2017 { id="1.7.0" }
+### 1.7.0 June 1, 2017 { id="1.7.0" }
- Added "copy to clipboard" buttons to code blocks
- Added support for multilingual site search
- Fixed search term highlighting for non-latin languages
-### 1.6.4 _ May 24, 2017 { id="1.6.4" }
+### 1.6.4 May 24, 2017 { id="1.6.4" }
- Fixed #337: JavaScript error for GitHub organization URLs
-### 1.6.3 _ May 16, 2017 { id="1.6.3" }
+### 1.6.3 May 16, 2017 { id="1.6.3" }
- Fixed #329: Broken source stats for private or unknown GitHub repos
-### 1.6.2 _ May 15, 2017 { id="1.6.2" }
+### 1.6.2 May 15, 2017 { id="1.6.2" }
- Fixed #316: Fatal error for git clone on Windows
- Fixed #320: Chrome 58 creates double underline for `abbr` tags
@@ -1444,12 +1498,12 @@
- Fixed miscalculated sidebar height due to missing margin collapse
- Changed deprecated MathJax CDN to Cloudflare
-### 1.6.1 _ April 23, 2017 { id="1.6.1" }
+### 1.6.1 April 23, 2017 { id="1.6.1" }
- Fixed following of active/focused element if search input is focused
- Fixed layer order of search component elements
-### 1.6.0 _ April 22, 2017 { id="1.6.0" }
+### 1.6.0 April 22, 2017 { id="1.6.0" }
- Added build test for Docker image on Travis
- Added search overlay for better user experience (focus)
@@ -1458,17 +1512,17 @@
- Fixed missing top spacing for first targeted element in content
- Fixed too small footnote divider when using larger font sizes
-### 1.5.5 _ April 20, 2017 { id="1.5.5" }
+### 1.5.5 April 20, 2017 { id="1.5.5" }
- Fixed #282: Browser search (Meta+F) is hijacked
-### 1.5.4 _ April 8, 2017 { id="1.5.4" }
+### 1.5.4 April 8, 2017 { id="1.5.4" }
- Fixed broken highlighting for two or more search terms
- Fixed missing search results when only a `h1` is present
- Fixed unresponsive overlay on Android
-### 1.5.3 _ April 7, 2017 { id="1.5.3" }
+### 1.5.3 April 7, 2017 { id="1.5.3" }
- Fixed deprecated calls for template variables
- Fixed wrong palette color for focused search result
@@ -1476,17 +1530,17 @@
- Fixed missing top spacing on 404 page
- Fixed missing right spacing on overflow of source container
-### 1.5.2 _ April 5, 2017 { id="1.5.2" }
+### 1.5.2 April 5, 2017 { id="1.5.2" }
- Added requirements as explicit dependencies in `setup.py`
- Fixed non-synchronized transitions in search form
-### 1.5.1 _ March 30, 2017 { id="1.5.1" }
+### 1.5.1 March 30, 2017 { id="1.5.1" }
- Fixed rendering and offset of targeted footnotes
- Fixed #238: Link on logo is not set to `site_url`
-### 1.5.0 _ March 24, 2017 { id="1.5.0" }
+### 1.5.0 March 24, 2017 { id="1.5.0" }
- Added support for localization of search placeholder
- Added keyboard events for quick access of search
@@ -1499,11 +1553,11 @@
- Fixed #231: Escape key doesn't exit search
- Removed old-style figures from font feature settings
-### 1.4.1 _ March 16, 2017 { id="1.4.1" }
+### 1.4.1 March 16, 2017 { id="1.4.1" }
- Fixed invalid destructuring attempt on NodeList (in Safari, Edge, IE)
-### 1.4.0 _ March 16, 2017 { id="1.4.0" }
+### 1.4.0 March 16, 2017 { id="1.4.0" }
- Added support for grouping searched sections by documents
- Added support for highlighting of search terms
@@ -1511,7 +1565,7 @@
- Fixed #216: table of contents icon doesn't show if `h1` is not present
- Reworked style and layout of search results for better usability
-### 1.3.0 _ March 11, 2017 { id="1.3.0" }
+### 1.3.0 March 11, 2017 { id="1.3.0" }
- Added support for page-specific title and description using metadata
- Added support for linking source files to documentation
@@ -1525,7 +1579,7 @@
- Reduced repaints to a minimum for non-tabs configuration
- Reduced contrast of edit button (slightly)
-### 1.2.0 _ March 3, 2017 { id="1.2.0" }
+### 1.2.0 March 3, 2017 { id="1.2.0" }
- Added `quote` (synonym: `cite`) style for admonitions
- Added help message to build pipeline
@@ -1533,11 +1587,11 @@
- Fixed #197: Link missing in tabs navigation on deeply nested items
- Removed unnecessary dev dependencies
-### 1.1.1 _ February 26, 2017 { id="1.1.1" }
+### 1.1.1 February 26, 2017 { id="1.1.1" }
- Fixed incorrectly displayed nested lists when using tabs
-### 1.1.0 _ February 26, 2017 { id="1.1.0" }
+### 1.1.0 February 26, 2017 { id="1.1.0" }
- Added tabs navigation feature (optional)
- Added Disqus integration (optional)
@@ -1552,36 +1606,36 @@
- Refactored and automated Docker build and PyPI release
- Refactored build scripts
-### 1.0.5 _ February 18, 2017 { id="1.0.5" }
+### 1.0.5 February 18, 2017 { id="1.0.5" }
- Fixed #153: Sidebar flows out of constrained area in Chrome 56
- Fixed #159: Footer jitter due to JavaScript if content is short
-### 1.0.4 _ February 16, 2017 { id="1.0.4" }
+### 1.0.4 February 16, 2017 { id="1.0.4" }
- Fixed #142: Documentation build errors if `h1` is defined as raw HTML
- Fixed #164: PyPI release does not build and install
- Fixed offsets of targeted headlines
- Increased sidebar font size by `0.12rem`
-### 1.0.3 _ January 22, 2017 { id="1.0.3" }
+### 1.0.3 January 22, 2017 { id="1.0.3" }
- Fixed #117: Table of contents items don't blur on fast scrolling
- Refactored sidebar positioning logic
- Further reduction of repaints
-### 1.0.2 _ January 15, 2017 { id="1.0.2" }
+### 1.0.2 January 15, 2017 { id="1.0.2" }
- Fixed #108: Horizontal scrollbar in content area
-### 1.0.1 _ January 14, 2017 { id="1.0.1" }
+### 1.0.1 January 14, 2017 { id="1.0.1" }
- Fixed massive repaints happening when scrolling
- Fixed footer back reference positions in case of overflow
- Fixed header logo from showing when the menu icon is rendered
- Changed scrollbar behavior to only show when content overflows
-### 1.0.0 _ January 13, 2017 { id="1.0.0" }
+### 1.0.0 January 13, 2017 { id="1.0.0" }
- Introduced Webpack for more sophisticated JavaScript bundling
- Introduced ESLint and Stylelint for code style checks
@@ -1610,27 +1664,29 @@
- Fixed live reload chain in watch mode when saving a template
- Fixed variable references to work with MkDocs 0.16
-### 0.2.4 _ June 26, 2016 { id="0.2.4" }
+---
+
+### 0.2.4 June 26, 2016 { id="0.2.4" }
- Fixed improperly set default favicon
- Fixed #33: Protocol relative URL for webfonts doesn't work with `file://`
- Fixed #34: IE11 on Windows 7 doesn't honor `max-width` on `main` tag
- Fixed #35: Add styling for blockquotes
-### 0.2.3 _ May 16, 2016 { id="0.2.3" }
+### 0.2.3 May 16, 2016 { id="0.2.3" }
- Fixed #25: Highlight inline fenced blocks
- Fixed #26: Better highlighting for keystrokes
- Fixed #30: Suboptimal syntax highlighting for PHP
-### 0.2.2 _ March 20, 2016 { id="0.2.2" }
+### 0.2.2 March 20, 2016 { id="0.2.2" }
- Fixed #15: Document Pygments dependency for CodeHilite
- Fixed #16: Favicon could not be set through `mkdocs.yml`
- Fixed #17: Put version into own container for styling
- Fixed #20: Fix rounded borders for tables
-### 0.2.1 _ March 12, 2016 { id="0.2.1" }
+### 0.2.1 March 12, 2016 { id="0.2.1" }
- Fixed #10: Invisible header after closing search bar with ESC key
- Fixed #13: Table cells don't wrap
@@ -1638,21 +1694,21 @@
- Corrected wrong path for static asset monitoring in Gulpfile.js
- Set up tracking of site search for Google Analytics
-### 0.2.0 _ February 24, 2016 { id="0.2.0" }
+### 0.2.0 February 24, 2016 { id="0.2.0" }
- Fixed #6: Include multiple color palettes via `mkdocs.yml`
- Fixed #7: Better colors for links inside admonition notes and warnings
- Fixed #9: Text for prev/next footer navigation should be customizable
- Refactored templates (replaced `if`/`else` with modifiers where possible)
-### 0.1.3 _ February 21, 2016 { id="0.1.3" }
+### 0.1.3 February 21, 2016 { id="0.1.3" }
- Fixed #3: Ordered lists within an unordered list have `::before` content
- Fixed #4: Click on Logo/Title without Github-Repository: `"None"`
- Fixed #5: Page without headlines renders empty list in table of contents
- Moved Modernizr to top to ensure basic usability in IE8
-### 0.1.2 _ February 16, 2016 { id="0.1.2" }
+### 0.1.2 February 16, 2016 { id="0.1.2" }
- Fixed styles for deep navigational hierarchies
- Fixed webfont delivery problem when hosted in subdirectories
@@ -1662,7 +1718,7 @@
- Set download link to latest version if available
- Set up tracking of outgoing links and actions for Google Analytics
-### 0.1.1 _ February 11, 2016 { id="0.1.1" }
+### 0.1.1 February 11, 2016 { id="0.1.1" }
- Fixed #1: GitHub stars don't work if the repo_url ends with a `/`
- Updated NPM and Bower dependencies to most recent versions
@@ -1670,6 +1726,6 @@
- Made MkDocs building/serving in build process optional
- Set up continuous integration with Travis
-### 0.1.0 _ February 9, 2016 { id="0.1.0" }
+### 0.1.0 February 9, 2016 { id="0.1.0" }
- Initial release
diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md
index 4a3e62dc5..a6df0388a 100644
--- a/docs/insiders/changelog.md
+++ b/docs/insiders/changelog.md
@@ -2,29 +2,29 @@
## Material for MkDocs Insiders
-### 4.27.0 _ December 20, 2022 { id="4.27.0" }
+### 4.27.0 December 20, 2022 { id="4.27.0" }
- Added built-in typeset plugin to preserve formatting in sidebars
- Added URL and table of contents support for blog categories
-### 4.26.6 _ November 28, 2022 { id="4.26.6" }
+### 4.26.6 November 28, 2022 { id="4.26.6" }
- Fixed #4683: Tags plugin crashes when a tag is empty
-### 4.26.5 _ November 27, 2022 { id="4.26.5" }
+### 4.26.5 November 27, 2022 { id="4.26.5" }
- Fixed #4632: Post excerpt title link doesn't point to top of the page
-### 4.26.4 _ November 27, 2022 { id="4.26.4" }
+### 4.26.4 November 27, 2022 { id="4.26.4" }
- Fixed redundant file extension when using privacy plugin
-### 4.26.3 _ November 15, 2022 { id="4.26.3" }
+### 4.26.3 November 15, 2022 { id="4.26.3" }
- Fixed #4637: Attachments w/o titles in related links error in blog plugin
- Fixed #4631: Remote favicons not downloaded and inlined by privacy plugin
-### 4.26.2 _ November 3, 2022 { id="4.26.2" }
+### 4.26.2 November 3, 2022 { id="4.26.2" }
- Updated MkDocs to 1.4.2
- Added support for tag compare functions when sorting on index pages
@@ -36,59 +36,59 @@
- Fixed #4542: Blog plugin doesn't allow for multiple instances
- Fixed #4532: Blog plugin doesn't allow for mixed use of date and datetime
-### 4.26.1 _ October 22, 2022 { id="4.26.1" }
+### 4.26.1 October 22, 2022 { id="4.26.1" }
- Improved reporting of configuration errors in tags plugin
- Fixed #4515: Privacy plugin fails when site URL is not defined
- Fixed #4514: Privacy plugin doesn't fetch Google fonts (4.26.0 regression)
-### 4.26.0 _ October 18, 2022 { id="4.26.0" }
+### 4.26.0 October 18, 2022 { id="4.26.0" }
- Refactored privacy plugin to prepare for new features
- Added support for `rel=noopener` links in privacy plugin
- Resolve encoding issues with blog and privacy plugin
-### 4.25.5 _ October 16, 2022 { id="4.25.5" }
+### 4.25.5 October 16, 2022 { id="4.25.5" }
- Updated MkDocs to 1.4.1
- Added namespace prefix to built-in plugins
- Updated `content` and `header` partial
-### 4.25.4 _ October 9, 2022 { id="4.25.4" }
+### 4.25.4 October 9, 2022 { id="4.25.4" }
- Fixed other path issues for standalone blogs (4.24.2 regression)
-### 4.25.3 _ October 9, 2022 { id="4.25.3" }
+### 4.25.3 October 9, 2022 { id="4.25.3" }
- Fixed #4457: Posts not collected for standalone blog (4.24.2 regression)
-### 4.25.2 _ October 4, 2022 { id="4.25.2" }
+### 4.25.2 October 4, 2022 { id="4.25.2" }
- Fixed #4452: Blog and tags plugin crash when specifying slugify function
-### 4.25.1 _ October 3, 2022 { id="4.25.1" }
+### 4.25.1 October 3, 2022 { id="4.25.1" }
- Updated `mkdocs-rss-plugin` in `Dockerfile` to fix MkDocs compat errors
-### 4.25.0 _ October 2, 2022 { id="4.25.0" }
+### 4.25.0 October 2, 2022 { id="4.25.0" }
- Added support for navigation subtitles
- Added support for defining an allow list for built-in tags plugin
- Added support for custom slugify functions for built-in tags plugin
- Improved stability of search plugin when using `--dirtyreload`
-### 4.24.2 _ October 1, 2022 { id="4.24.2" }
+### 4.24.2 October 1, 2022 { id="4.24.2" }
- Updated MkDocs to 1.4
- Fixed compatibility issues with MkDocs 1.4
- Fixed incorrectly generated paths in privacy plugin
- Fixed blog index page not showing navigation when using meta plugin
-### 4.24.1 _ September 30, 2022 { id="4.24.1" }
+### 4.24.1 September 30, 2022 { id="4.24.1" }
- Fixed #4430: build error when enabling consent without repository URL
-### 4.24.0 _ September 27, 2022 { id="4.24.0" }
+### 4.24.0 September 27, 2022 { id="4.24.0" }
- Added support for custom content on index pages (blog)
- Added support for keeping content on paginated index pages (blog)
@@ -98,265 +98,265 @@
- Fixed #4396: Front matter of index pages not inherited by pagination (blog)
- Improved performance by building post excerpts once (blog)
-### 4.23.6 _ September 22, 2022 { id="4.23.6" }
+### 4.23.6 September 22, 2022 { id="4.23.6" }
- Fixed #4389: Blog posts in first week of year in wrong archive
- Fixed (= switched) footer previous and next links for blog posts
-### 4.23.5 _ September 18, 2022 { id="4.23.5" }
+### 4.23.5 September 18, 2022 { id="4.23.5" }
- Fixed #4367: Improved blog plugin date handling for MultiMarkdown syntax
- Fixed #4374: Fixed invalid URLs of related links to other blog posts
-### 4.23.4 _ September 14, 2022 { id="4.23.4" }
+### 4.23.4 September 14, 2022 { id="4.23.4" }
- Fixed #4365: Recursion error in blog plugin due to `deepcopy`
- Fixed path errors for blog plugin on Windows
- Fixed publishing workflow in forked repositories
-### 4.23.3 _ September 13, 2022 { id="4.23.3" }
+### 4.23.3 September 13, 2022 { id="4.23.3" }
- Fixed previous and next page links for drafts of blog posts
-### 4.23.2 _ September 13, 2022 { id="4.23.2" }
+### 4.23.2 September 13, 2022 { id="4.23.2" }
- Fixed #4348: Blog plugin crashes on custom `nav` title
- Fixed blog plugin crashing when category contained only drafts
- Fixed rendering of content from blog index file
-### 4.23.1 _ September 12, 2022 { id="4.23.1" }
+### 4.23.1 September 12, 2022 { id="4.23.1" }
- Fixed #4345: Blog plugin errors with default settings
-### 4.23.0 _ September 12, 2022 { id="4.23.0" }
+### 4.23.0 September 12, 2022 { id="4.23.0" }
- Added blogging support via built-in blog plugin
-### 4.22.1 _ September 7, 2022 { id="4.22.1" }
+### 4.22.1 September 7, 2022 { id="4.22.1" }
- Fixed #4217: Tooltips in data tables render in wrong position
-### 4.22.0 _ August 21, 2022 { id="4.22.0" }
+### 4.22.0 August 21, 2022 { id="4.22.0" }
- Added support for navigation status
-### 4.21.1 _ August 13, 2022 { id="4.21.1" }
+### 4.21.1 August 13, 2022 { id="4.21.1" }
- Fixed #4176: Broken image when avatar is served by Gravatar
- Fixed #4212: Deferred search initialization for file:// locations
-### 4.21.0 _ July 17, 2022 { id="4.21.0" }
+### 4.21.0 July 17, 2022 { id="4.21.0" }
- Added meta plugin: set front matter for all pages in a folder
- Fixed #4114: Tags plugin fails if only `tags_extra_files` is set
-### 4.20.1 _ July 11, 2022 { id="4.20.1" }
+### 4.20.1 July 11, 2022 { id="4.20.1" }
- Fixed #4105: Tags plugin fails if `tags_file` is not set (4.20.0 regression)
-### 4.20.0 _ July 7, 2022 { id="4.20.0" }
+### 4.20.0 July 7, 2022 { id="4.20.0" }
- Added support for additional tags indexes
- Fixed #4100: Tag icons not shown in tags index
-### 4.19.2 _ July 4, 2022 { id="4.19.2" }
+### 4.19.2 July 4, 2022 { id="4.19.2" }
- Fixed #4051: Privacy plugin fails if symlinking isn't allowed on Windows
-### 4.19.1 _ June 25, 2022 { id="4.19.1" }
+### 4.19.1 June 25, 2022 { id="4.19.1" }
- Added `mkdocs-git-committers-plugin` to Dockerfile
- Added `mkdocs-git-revision-date-localized-plugin` to Dockerfile
-### 4.19.0 _ June 24, 2022 { id="4.19.0" }
+### 4.19.0 June 24, 2022 { id="4.19.0" }
- Added support for document contributors
- Updated French translations for cookie consent
-### 4.18.2 _ June 16, 2022 { id="4.18.2" }
+### 4.18.2 June 16, 2022 { id="4.18.2" }
- Fixed #4026: Fixed tooltips not mounted for nested navigation links
-### 4.18.1 _ June 14, 2022 { id="4.18.1" }
+### 4.18.1 June 14, 2022 { id="4.18.1" }
- Fixed #3990: Chinese search highlighting not working on non-boundaries
-### 4.18.0 _ June 11, 2022 { id="4.18.0" }
+### 4.18.0 June 11, 2022 { id="4.18.0" }
- Added support for automatic dark/light mode
- Fixed #4009: Privacy plugin uses invalid paths for file cache on Windows
-### 4.17.2 _ June 5, 2022 { id="4.17.2" }
+### 4.17.2 June 5, 2022 { id="4.17.2" }
- Added support for custom jieba dictionaries (Chinese search)
-### 4.17.1 _ June 5, 2022 { id="4.17.1" }
+### 4.17.1 June 5, 2022 { id="4.17.1" }
- Added support for cookie consent reject button
- Added support for cookie consent custom button ordering
- Fixed #3988: Content tab not focused after alternating anchor links
-### 4.17.0 _ June 4, 2022 { id="4.17.0" }
+### 4.17.0 June 4, 2022 { id="4.17.0" }
- Added support for content tabs anchor links (deep linking)
- Fixed #3975: Detect composition events in search interface (Chinese)
- Fixed #3980: Search plugin doesn't use title set via front matter
-### 4.16.2 _ May 29, 2022 { id="4.16.2" }
+### 4.16.2 May 29, 2022 { id="4.16.2" }
- Fixed #3961: Nested sections triggered build error for navigation tabs
-### 4.16.1 _ May 28, 2022 { id="4.16.1" }
+### 4.16.1 May 28, 2022 { id="4.16.1" }
- Switched feedback widget rating titles to tooltips
- Improved contrast of link colors for light/dark color schemes
- Fixed #3950: Sticky navigation tabs rendering broken (4.15.2 regression)
- Fixed #3958: Links invisible when using `white` primary color
-### 4.16.0 _ May 25, 2022 { id="4.16.0" }
+### 4.16.0 May 25, 2022 { id="4.16.0" }
- Added support for navigation pruning
- Fixed search results for non-segmented characters (4.15.2 regression)
-### 4.15.2 _ May 22, 2022 { id="4.15.2" }
+### 4.15.2 May 22, 2022 { id="4.15.2" }
- Removed workaround for `abbr` on touch devices (superseded by tooltips)
- Fixed #3915: Improved Chinese search query segmentation
- Fixed #3938: Fixed tooltips position for navigation titles with ellipsis
-### 4.15.1 _ May 14, 2022 { id="4.15.1" }
+### 4.15.1 May 14, 2022 { id="4.15.1" }
- Improved performance of element focus obervables
- Fixed #3531: Added prev/next buttons to content tabs
- Fixed tooltip positioning when host element is hidden
-### 4.15.0 _ May 8, 2022 { id="4.15.0" }
+### 4.15.0 May 8, 2022 { id="4.15.0" }
- Added support for improved tooltips
- Fixed #3785: Show tooltip on hover for overflowing navigation link
-### 4.14.0 _ May 5, 2022 { id="4.14.0" }
+### 4.14.0 May 5, 2022 { id="4.14.0" }
- Added Chinese language support to built-in search plugin
- Fixed all-numeric page titles raising error in social plugin
-### 4.13.2 _ April 30, 2022 { id="4.13.2" }
+### 4.13.2 April 30, 2022 { id="4.13.2" }
- Improved caching of downloaded resources in privacy plugin
- Fixed #3851: External images not downloaded by privacy plugin
-### 4.13.1 _ April 25, 2022 { id="4.13.1" }
+### 4.13.1 April 25, 2022 { id="4.13.1" }
- Fixed #3839: Tags plugin breaks without icons (4.13.0 regression)
-### 4.13.0 _ April 24, 2022 { id="4.13.0" }
+### 4.13.0 April 24, 2022 { id="4.13.0" }
- Added support for tag icons
-### 4.12.0 _ March 27, 2022 { id="4.12.0" }
+### 4.12.0 March 27, 2022 { id="4.12.0" }
- Added support for card grids and grid layouts
- Fixed #3685: Annotations sometimes broken when using instant loading
- Fixed #3742: Automatically add Mermaid.js when building for offline usage
-### 4.11.0 _ March 6, 2022 { id="4.11.0" }
+### 4.11.0 March 6, 2022 { id="4.11.0" }
- Added support for excluding external assets from privacy plugin
-### 4.10.1 _ March 2, 2022 { id="4.10.1" }
+### 4.10.1 March 2, 2022 { id="4.10.1" }
- Added missing build dependencies to Dockerfile
- Fixed encoding issues in privacy plugin, now forcing UTF-8 encoding
- Fixed #3624: Scroll to active navigation item unreliable in Firefox
- Fixed #3642: Privacy plugin errors when font setting was omitted
-### 4.10.0 _ February 27, 2022 { id="4.10.0" }
+### 4.10.0 February 27, 2022 { id="4.10.0" }
- Added support for offline plugin (supersedes offline search support)
- Improved built-in privacy plugin to download nested JavaScript assets
- Refactored configuration of built-in privacy plugin
-### 4.9.1 _ February 21, 2022 { id="4.9.1" }
+### 4.9.1 February 21, 2022 { id="4.9.1" }
- Fixed #3610: missing `lxml` dependency for privacy plugin
- Fixed error when charset is missing in `content-type` header
-### 4.9.0 _ February 20, 2022 { id="4.9.0" }
+### 4.9.0 February 20, 2022 { id="4.9.0" }
- Added privacy plugin: automatic downloading of external assets
-### 4.8.3 _ February 13, 2022 { id="4.8.3" }
+### 4.8.3 February 13, 2022 { id="4.8.3" }
- Fixed #3560: Mermaid diagrams don't render for `file://` locations
-### 4.8.2 _ February 10, 2022 { id="4.8.2" }
+### 4.8.2 February 10, 2022 { id="4.8.2" }
- Fixed #3559: Mermaid diagrams don't render inside closed `details`
-### 4.8.1 _ February 6, 2022 { id="4.8.1" }
+### 4.8.1 February 6, 2022 { id="4.8.1" }
- Fixed jump back to top on mobile when using anchor following
-### 4.8.0 _ February 6, 2022 { id="4.8.0" }
+### 4.8.0 February 6, 2022 { id="4.8.0" }
- Added support for anchor following table of contents (= auto scroll)
-### 4.7.2 _ February 2, 2022 { id="4.7.2" }
+### 4.7.2 February 2, 2022 { id="4.7.2" }
- Fixed #3526: Transparent sidebar title due to Safari bug
- Fixed #3528: Firefox sometimes clips text in flow chart diagrams
-### 4.7.1 _ January 30, 2022 { id="4.7.1" }
+### 4.7.1 January 30, 2022 { id="4.7.1" }
- Fixed #3506: Tags index not respecting title set via front matter
-### 4.7.0 _ January 25, 2022 { id="4.7.0" }
+### 4.7.0 January 25, 2022 { id="4.7.0" }
- Added native support for offline search
-### 4.6.1 _ January 16, 2022 { id="4.6.1" }
+### 4.6.1 January 16, 2022 { id="4.6.1" }
- Fixed #3459: Section index pages picking up wrong title
-### 4.6.0 _ January 11, 2022 { id="4.6.0" }
+### 4.6.0 January 11, 2022 { id="4.6.0" }
- Added support for annotations (outside of code blocks)
-### 4.5.2 _ January 8, 2022 { id="4.5.2" }
+### 4.5.2 January 8, 2022 { id="4.5.2" }
- Fixed #3440: Content tab indicator not moving when using linking
- Fixed #3445: Content tab switch flickers/jitters when using linking
-### 4.5.1 _ January 2, 2022 { id="4.5.1" }
+### 4.5.1 January 2, 2022 { id="4.5.1" }
- Added support for setting initial state of cookie consent
- Fixed #3396: Disappearing link in navigation due to Safari bug
-### 4.5.0 _ December 16, 2021 { id="4.5.0" }
+### 4.5.0 December 16, 2021 { id="4.5.0" }
- Added support for navigation icons
-### 4.4.0 _ December 10, 2021 { id="4.4.0" }
+### 4.4.0 December 10, 2021 { id="4.4.0" }
- Added support for code annotation anchor links (deep linking)
- Added new code annotation syntax modifier to strip comment
- Updated German translations for cookie consent
-### 4.3.0 _ December 5, 2021 { id="4.3.0" }
+### 4.3.0 December 5, 2021 { id="4.3.0" }
- Added support for custom fonts in social cards
- Fixed #3300: Announcement bar reappearing when using instant loading
-### 4.2.0 _ December 2, 2021 { id="4.2.0" }
+### 4.2.0 December 2, 2021 { id="4.2.0" }
- Added support for dismissable announcement bar
- Added support for named placeholders in feedback widget
-### 4.1.0 _ November 30, 2021 { id="4.1.0" }
+### 4.1.0 November 30, 2021 { id="4.1.0" }
- Added support for passing page title to feedback forms
-### 4.0.0 _ November 28, 2021 { id="4.0.0" }
+### 4.0.0 November 28, 2021 { id="4.0.0" }
- Removed deprecated content tabs legacy implementation
- Removed deprecated `seealso` admonition type
@@ -374,7 +374,7 @@
- Improved keyboard navigation for footnotes
- Fixed #3214: Search highlighting breaks site when empty
-### 3.2.3 _ November 20, 2021 { id="3.2.3" }
+### 3.2.3 November 20, 2021 { id="3.2.3" }
- Updated Swedish and French translations
- Removed support for `.mermaid-experimental` class (now `.mermaid`)
@@ -382,56 +382,56 @@
- Fixed #3216: Cookie consent not dismissed when invoked via anchor
- Fixed #3232: Mermaid.js sometimes runs twice (race condition)
-### 3.2.2 _ November 6, 2021 { id="3.2.2" }
+### 3.2.2 November 6, 2021 { id="3.2.2" }
- Fixed always last feedback rating being sent
- Fixed #3145: Code annotations eat whole comment lines
- Fixed #3170: Feedback widget doesn't send data to GA4
-### 3.2.1 _ November 4, 2021 { id="3.2.1" }
+### 3.2.1 November 4, 2021 { id="3.2.1" }
- Added support for custom Mermaid.js version via additional JavaScript
- Fixed some configuration edge cases for tags plugin (3.1.5 regression)
- Fixed feedback widget title not being centered in Firefox
- Fixed #3179: Safari doesn't send request for feedback widget
-### 3.2.0 _ October 31, 2021 { id="3.2.0" }
+### 3.2.0 October 31, 2021 { id="3.2.0" }
- Added support for feedback widget (Was this page helpful?)
-### 3.1.5 _ October 28, 2021 { id="3.1.5" }
+### 3.1.5 October 28, 2021 { id="3.1.5" }
- Fixed #3144: Rogue link when using tags with auto-populated navigation
- Fixed #3147: Code block line numbers appear in search results
- Fixed #3158: Social cards do not strip HTML tags from title
-### 3.1.4 _ October 17, 2021 { id="3.1.4" }
+### 3.1.4 October 17, 2021 { id="3.1.4" }
- Fixed #2974: Text cropped with other fonts than `Roboto` in social plugin
- Fixed #3099: Encoding problems with non-latin character in social plugin
- Fixed #3112: Japanese segmenter not executed as part of new tokenizer
- Fixed tags (front matter) appearing in search with disabled tags plugin
-### 3.1.3 _ October 12, 2021 { id="3.1.3" }
+### 3.1.3 October 12, 2021 { id="3.1.3" }
- Added warnings to search plugin for unsupported options and syntax
- Fixed #3503: Search sometimes returns entire page
- Fixed #3089: Single-line code annotations disappear when printing
-### 3.1.2 _ October 6, 2021 { id="3.1.2" }
+### 3.1.2 October 6, 2021 { id="3.1.2" }
- Fixed incorrect path separators for social cards on Windows
-### 3.1.1 _ September 26, 2021 { id="3.1.1" }
+### 3.1.1 September 26, 2021 { id="3.1.1" }
- Fixed ordering bug in search exclusion logic
-### 3.1.0 _ September 26, 2021 { id="3.1.0" }
+### 3.1.0 September 26, 2021 { id="3.1.0" }
- Added support for excluding pages, sections, and elements from search
- Fixed #2803: Code block annotations not visible when printing
-### 3.0.1 _ September 19, 2021 { id="3.0.1" }
+### 3.0.1 September 19, 2021 { id="3.0.1" }
- Added support for using literal `h1-6` tags for search plugin
- Fixed search plugin breaking on void elements without slashes
@@ -439,7 +439,7 @@
- Fixed search plugin handling of multiple `h1` headlines
- Fixed search plugin handling of missing `h1` headlines
-### 3.0.0 _ September 13, 2021 { id="3.0.0" }
+### 3.0.0 September 13, 2021 { id="3.0.0" }
- Rewrite of MkDocs' search plugin
- Added support for rich search previews
@@ -447,41 +447,41 @@
- Improved search indexing performance (twice as fast)
- Improved search highlighting
-### 2.13.3 _ September 1, 2021 { id="2.13.3" }
+### 2.13.3 September 1, 2021 { id="2.13.3" }
- Added support for disabling social card generation
-### 2.13.2 _ August 25, 2021 { id="2.13.2" }
+### 2.13.2 August 25, 2021 { id="2.13.2" }
- Fixed #2965: Social plugin error when primary color is not defined
-### 2.13.1 _ August 21, 2021 { id="2.13.1" }
+### 2.13.1 August 21, 2021 { id="2.13.1" }
- Fixed #2948: Social cards are not cached
- Fixed #2953: Mermaid.js diagrams can't be centered anymore
-### 2.13.0 _ August 7, 2021 { id="2.13.0" }
+### 2.13.0 August 7, 2021 { id="2.13.0" }
- Added support for custom colors in social cards
-### 2.12.2 _ August 4, 2021 { id="2.12.2" }
+### 2.12.2 August 4, 2021 { id="2.12.2" }
- Fixed #2891: Division by zero error in social plugin
-### 2.12.1 _ July 26, 2021 { id="2.12.1" }
+### 2.12.1 July 26, 2021 { id="2.12.1" }
- Fixed error in social plugin when `site_description` was not set
- Fixed error in social plugin for non-ASCII characters
-### 2.12.0 _ July 25, 2021 { id="2.12.0" }
+### 2.12.0 July 25, 2021 { id="2.12.0" }
- Added support for social cards
-### 2.11.1 _ July 20, 2021 { id="2.11.1" }
+### 2.11.1 July 20, 2021 { id="2.11.1" }
- Fixed order of tags index, now sorted alphabetically
-### 2.11.0 _ July 18, 2021 { id="2.11.0" }
+### 2.11.0 July 18, 2021 { id="2.11.0" }
- Improved Mermaid.js intergration, now stable
- Added support for sequence diagrams
@@ -489,193 +489,193 @@
- Added support for cookie consent configuration
- Added feature flag to always enable annotations
-### 2.10.0 _ July 10, 2021 { id="2.10.0" }
+### 2.10.0 July 10, 2021 { id="2.10.0" }
- Added support for cookie consent
- Fixed #2807: Back-to-top button not hidden when using sticky tabs
-### 2.9.2 _ May 30, 2021 { id="2.9.2" }
+### 2.9.2 May 30, 2021 { id="2.9.2" }
- Moved tags to partial for easier customization
- Added support for hiding tags on any page
-### 2.9.1 _ May 24, 2021 { id="2.9.1" }
+### 2.9.1 May 24, 2021 { id="2.9.1" }
- Added missing guard for linking of content tabs
-### 2.9.0 _ May 23, 2021 { id="2.9.0" }
+### 2.9.0 May 23, 2021 { id="2.9.0" }
- Added support for linking of content tabs
-### 2.8.0 _ May 12, 2021 { id="2.8.0" }
+### 2.8.0 May 12, 2021 { id="2.8.0" }
- Added support for boosting pages in search
-### 2.7.2 _ May 8, 2021 { id="2.7.2" }
+### 2.7.2 May 8, 2021 { id="2.7.2" }
- Fixed #2638: Warnings shown when using `tags` plugin without directory URLs
-### 2.7.1 _ May 3, 2021 { id="2.7.1" }
+### 2.7.1 May 3, 2021 { id="2.7.1" }
- Fixed `git-revision-date-localized` plugin integration (2.7.0 regression)
-### 2.7.0 _ May 1, 2021 { id="2.7.0" }
+### 2.7.0 May 1, 2021 { id="2.7.0" }
- Added support for tags (with search integration)
-### 2.6.0 _ April 11, 2021 { id="2.6.0" }
+### 2.6.0 April 11, 2021 { id="2.6.0" }
- Stay on page when switching versions
-### 2.5.0 _ March 28, 2021 { id="2.5.0" }
+### 2.5.0 March 28, 2021 { id="2.5.0" }
- Added support for version warning
-### 2.4.0 _ March 20, 2021 { id="2.4.0" }
+### 2.4.0 March 20, 2021 { id="2.4.0" }
- Added support for custom admonition icons
- Fixed #2444: Code block annotations with extra comments have wrong index
-### 2.3.1 _ March 14, 2021 { id="2.3.1" }
+### 2.3.1 March 14, 2021 { id="2.3.1" }
- Fixed anchor offset for permalinks when using sticky navigation tabs
-### 2.3.0 _ March 13, 2021 { id="2.3.0" }
+### 2.3.0 March 13, 2021 { id="2.3.0" }
- Added support for back-to-top button
-### 2.2.1 _ March 4, 2021 { id="2.2.1" }
+### 2.2.1 March 4, 2021 { id="2.2.1" }
- Fixed #2382: Repository stats failing when no release tag is present
-### 2.2.0 _ February 28, 2021 { id="2.2.0" }
+### 2.2.0 February 28, 2021 { id="2.2.0" }
- Added support for code block annotations
-### 2.1.0 _ February 26, 2021 { id="2.1.0" }
+### 2.1.0 February 26, 2021 { id="2.1.0" }
- Added support for anchor tracking
-### 2.0.0 _ February 24, 2021 { id="2.0.0" }
+### 2.0.0 February 24, 2021 { id="2.0.0" }
- Migrated Insiders to the new architecture
- Swapped color palette toggle configuration
-### 1.17.0 _ January 31, 2021 { id="1.17.0" }
+### 1.17.0 January 31, 2021 { id="1.17.0" }
- Added support for section index pages
-### 1.16.1 _ January 26, 2021 { id="1.16.1" }
+### 1.16.1 January 26, 2021 { id="1.16.1" }
- Fixed #2249: Instant loading + sticky tabs result in invalid links
- Fixed #2248: Search highlighting URL parameter always added
- Fixed #2235: Version selector doesn't select current version for aliases
-### 1.16.0 _ January 7, 2021 { id="1.16.0" }
+### 1.16.0 January 7, 2021 { id="1.16.0" }
- Added latest release to repository info (GitHub)
- Slight facelift of repository info (lighter fonts, spacing and icons)
-### 1.15.0 _ January 2, 2021 { id="1.15.0" }
+### 1.15.0 January 2, 2021 { id="1.15.0" }
- Added support for native Mermaid.js integration
-### 1.14.0 _ December 30, 2020 { id="1.14.0" }
+### 1.14.0 December 30, 2020 { id="1.14.0" }
- Added support for sharing searches
-### 1.13.2 _ December 22, 2020 { id="1.13.2" }
+### 1.13.2 December 22, 2020 { id="1.13.2" }
- Fixed version selector + sticky tabs navigation rendering issues
- Fixed version selector wrapping
-### 1.13.1 _ December 20, 2020 { id="1.13.1" }
+### 1.13.1 December 20, 2020 { id="1.13.1" }
- Removed horizontal scrollbars on language and version selector
- Fixed type conversion in JavaScript config
-### 1.13.0 _ December 13, 2020 { id="1.13.0" }
+### 1.13.0 December 13, 2020 { id="1.13.0" }
- Refactored navigation tabs to simplify grouping behavior
- Added support for sticky navigation tabs
- Added support for arbitrary links in navigation tabs
- Fixed #2098: Subsequent active subsection not highlighted correctly
-### 1.12.1 _ December 8, 2020 { id="1.12.1" }
+### 1.12.1 December 8, 2020 { id="1.12.1" }
- Fixed empty language selector being shown
-### 1.12.0 _ December 6, 2020 { id="1.12.0" }
+### 1.12.0 December 6, 2020 { id="1.12.0" }
- Added support for adding a language selector
-### 1.11.2 _ November 29, 2020 { id="1.11.2" }
+### 1.11.2 November 29, 2020 { id="1.11.2" }
- Fixed #2068: Search highlight interprets code blocks as JavaScript
-### 1.11.1 _ November 29, 2020 { id="1.11.1" }
+### 1.11.1 November 29, 2020 { id="1.11.1" }
- Refactored styling to be more stable and easier to adjust
- Fixed some styling regressions from latest features
-### 1.11.0 _ November 22, 2020 { id="1.11.0" }
+### 1.11.0 November 22, 2020 { id="1.11.0" }
- Added support for rendering admonitions as inline blocks
-### 1.10.0 _ November 15, 2020 { id="1.10.0" }
+### 1.10.0 November 15, 2020 { id="1.10.0" }
- Added support for integrating table of contents into navigation
-### 1.9.0 _ November 7, 2020 { id="1.9.0" }
+### 1.9.0 November 7, 2020 { id="1.9.0" }
- Added support for hiding navigation and table of contents on any page
- Removed autohiding table of contents when empty
-### 1.8.0 _ November 1, 2020 { id="1.8.0" }
+### 1.8.0 November 1, 2020 { id="1.8.0" }
- Added support for navigation sections
- Fixed appearance of inactive search suggestions
-### 1.7.0 _ October 25, 2020 { id="1.7.0" }
+### 1.7.0 October 25, 2020 { id="1.7.0" }
- Added support for deploying multiple versions
- Fixed alignment of sidebar when content area is too small
-### 1.6.0 _ October 11, 2020 { id="1.6.0" }
+### 1.6.0 October 11, 2020 { id="1.6.0" }
- Added support for search suggestions to save keystrokes
- Added support for removing __Made with Material for MkDocs__ from footer
- Fixed #1915: search should go to first result by pressing ++enter++
-### 1.5.1 _ September 21, 2020 { id="1.5.1" }
+### 1.5.1 September 21, 2020 { id="1.5.1" }
- Fixed content area stretching to whole width for long code blocks
-### 1.5.0 _ September 19, 2020 { id="1.5.0" }
+### 1.5.0 September 19, 2020 { id="1.5.0" }
- Added support for autohiding table of contents when empty
-### 1.4.1 _ September 6, 2020 { id="1.4.1" }
+### 1.4.1 September 6, 2020 { id="1.4.1" }
- Improved typeahead and search result relevance and scoring
-### 1.4.0 _ August 30, 2020 { id="1.4.0" }
+### 1.4.0 August 30, 2020 { id="1.4.0" }
- Added support for autohiding header on scroll
-### 1.3.0 _ August 26, 2020 { id="1.3.0" }
+### 1.3.0 August 26, 2020 { id="1.3.0" }
- Added support for user-selectable color palettes
-### 1.2.0 _ August 11, 2020 { id="1.2.0" }
+### 1.2.0 August 11, 2020 { id="1.2.0" }
- Added feature to expand navigation by default
-### 1.1.0 _ August 3, 2020 { id="1.1.0" }
+### 1.1.0 August 3, 2020 { id="1.1.0" }
- Added highlighting of search results
-### 1.0.0 _ July 14, 2020 { id="1.0.0" }
+### 1.0.0 July 14, 2020 { id="1.0.0" }
- Added grouping of search results
- Added missing query terms to search result
diff --git a/docs/upgrade.md b/docs/upgrade.md
index 3e03fea77..95a3f80e2 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -12,6 +12,75 @@ Show the currently installed version with:
pip show mkdocs-material
```
+## Upgrading from 8.x to 9.x
+
+This major release includes a brand new search implementation that is faster
+and allows for rich previews, advanced tokenization and better highlighting.
+It was available as part of Insiders for over a year, and now that the funding
+goal was hit, makes its way into the community edition.
+
+### Changes to `mkdocs.yml`
+
+#### `content.code.copy`
+
+The copy-to-clipboard buttons are now opt-in and can be enabled or disabled
+per block. If you wish to enable them for all code blocks, add the following
+lines to `mkdocs.yml`:
+
+``` yaml
+theme:
+ features:
+ - content.code.copy
+```
+
+#### `content.action.*`
+
+A "view source" button can be shown next to the "edit this page" button, both
+of which must now be explicitly enabled. Add the following lines to
+`mkdocs.yml`:
+
+``` yaml
+theme:
+ features:
+ - content.action.edit
+ - content.action.view
+```
+
+#### `navigation.footer`
+
+The _previous_ and _next_ buttons in the footer are now opt-in. If you wish to
+keep them for your documentation, add the following lines to `mkdocs.yml`:
+
+``` yaml
+theme:
+ features:
+ - navigation.footer
+```
+
+#### `theme.language`
+
+The Korean and Norwegian language codes were renamed, as they were non-standard:
+
+- `kr` to `ko`
+- `no` to `nb`
+
+#### `feedback.ratings`
+
+The old, nameless placeholders were removed (after being deprecated for several
+months). Make sure to switch to the new named placeholders `{title}` and `{url}`:
+
+```
+https://github.com/.../issues/new/?title=[Feedback]+{title}+-+{url}
+```
+
+### Changes to `*.html` files
+
+The templates have undergone a series of changes. If you have customized
+Material for MkDocs with theme extension, be sure to incorporate the latest
+changes into your templates. A good starting point is to [inspect the diff].
+
+ [inspect the diff]: https://github.com/squidfunk/mkdocs-material/pull/4628/files#diff-3ca112736b9164701b599f34780107abf14bb79fe110c478cac410be90899828
+
## Upgrading from 7.x to 8.x
### What's new?