2020-12-21 19:38:58 +03:00
|
|
|
---
|
|
|
|
|
template: overrides/main.html
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Changelog
|
|
|
|
|
|
|
|
|
|
## Material for MkDocs Insiders
|
|
|
|
|
|
2021-11-06 19:27:40 +03:00
|
|
|
### 3.2.2 <small>_ November 6, 2021</small> { id="3.2.2" }
|
|
|
|
|
|
|
|
|
|
- Fixed always last feedback rating being sent
|
2021-11-08 11:56:30 +03:00
|
|
|
- Fixed #3145: code annotations eat whole comment lines
|
|
|
|
|
- Fixed #3170: Feedback widget doesn't send data to GA4
|
2021-11-06 19:27:40 +03:00
|
|
|
|
2021-11-04 19:28:02 +03:00
|
|
|
### 3.2.1 <small>_ November 4, 2021</small> { 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
|
|
|
|
|
|
2021-10-31 12:11:12 +03:00
|
|
|
### 3.2.0 <small>_ October 31, 2021</small> { id="3.2.0" }
|
|
|
|
|
|
|
|
|
|
- Added support for feedback widget (Was this page helpful?)
|
|
|
|
|
|
2021-10-28 23:42:07 +03:00
|
|
|
### 3.1.5 <small>_ October 28, 2021</small> { 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
|
|
|
|
|
|
2021-10-17 19:27:00 +03:00
|
|
|
### 3.1.4 <small>_ October 17, 2021</small> { 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
|
|
|
|
|
|
2021-10-13 11:37:00 +03:00
|
|
|
### 3.1.3 <small>_ October 12, 2021</small> { 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
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 3.1.2 <small>_ October 6, 2021</small> { id="3.1.2" }
|
2021-10-06 20:45:25 +03:00
|
|
|
|
|
|
|
|
- Fixed incorrect path separators for social cards on Windows
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 3.1.1 <small>_ September 26, 2021</small> { id="3.1.1" }
|
2021-09-26 18:53:29 +03:00
|
|
|
|
|
|
|
|
- Fixed ordering bug in search exclusion logic
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 3.1.0 <small>_ September 26, 2021</small> { id="3.1.0" }
|
2021-09-26 18:53:29 +03:00
|
|
|
|
|
|
|
|
- Added support for excluding pages, sections, and elements from search
|
|
|
|
|
- Fixed #2803: Code block annotations not visible when printing
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 3.0.1 <small>_ September 19, 2021</small> { id="3.0.1" }
|
2021-09-19 17:46:34 +03:00
|
|
|
|
|
|
|
|
- Added support for using literal `h1-6` tags for search plugin
|
|
|
|
|
- Fixed search plugin breaking on void elements without slashes
|
|
|
|
|
- Fixed search plugin filtering link contents from headlines
|
|
|
|
|
- Fixed search plugin handling of multiple `h1` headlines
|
|
|
|
|
- Fixed search plugin handling of missing `h1` headlines
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 3.0.0 <small>_ September 13, 2021</small> { id="3.0.0" }
|
2021-09-13 19:14:28 +03:00
|
|
|
|
|
|
|
|
- Rewrite of MkDocs' search plugin
|
|
|
|
|
- Added support for rich search previews
|
|
|
|
|
- Added support for tokenizer with lookahead
|
|
|
|
|
- Improved search indexing performance (twice as fast)
|
|
|
|
|
- Improved search highlighting
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.13.3 <small>_ September 1, 2021</small> { id="2.13.3" }
|
2021-09-01 22:47:14 +03:00
|
|
|
|
|
|
|
|
- Added support for disabling social card generation
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.13.2 <small>_ August 25, 2021</small> { id="2.13.2" }
|
2021-08-25 09:49:25 +03:00
|
|
|
|
|
|
|
|
- Fixed #2965: Social plugin error when primary color is not defined
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.13.1 <small>_ August 21, 2021</small> { id="2.13.1" }
|
2021-08-22 20:08:54 +03:00
|
|
|
|
|
|
|
|
- Fixed #2948: Social cards are not cached
|
|
|
|
|
- Fixed #2953: Mermaid.js diagrams can't be centered anymore
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.13.0 <small>_ August 7, 2021</small> { id="2.13.0" }
|
2021-08-07 14:12:05 +03:00
|
|
|
|
|
|
|
|
- Added support for custom colors in social cards
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.12.2 <small>_ August 4, 2021</small> { id="2.12.2" }
|
2021-08-04 22:52:07 +03:00
|
|
|
|
|
|
|
|
- Fixed #2891: Division by zero error in social plugin
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.12.1 <small>_ July 26, 2021</small> { id="2.12.1" }
|
2021-07-26 19:48:11 +03:00
|
|
|
|
2021-08-04 22:52:07 +03:00
|
|
|
- Fixed error in social plugin when `site_description` was not set
|
|
|
|
|
- Fixed error in social plugin for non-ASCII characters
|
2021-07-26 19:48:11 +03:00
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.12.0 <small>_ July 25, 2021</small> { id="2.12.0" }
|
2021-07-25 16:42:35 +03:00
|
|
|
|
|
|
|
|
- Added support for social cards
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.11.1 <small>_ July 20, 2021</small> { id="2.11.1" }
|
2021-07-20 11:01:21 +03:00
|
|
|
|
|
|
|
|
- Fixed order of tags index, now sorted alphabetically
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.11.0 <small>_ July 18, 2021</small> { id="2.11.0" }
|
2021-07-18 19:05:20 +03:00
|
|
|
|
|
|
|
|
- Improved Mermaid.js intergration, now stable
|
|
|
|
|
- Added support for sequence diagrams
|
|
|
|
|
- Added support for entity relationship diagrams
|
|
|
|
|
- Added support for cookie consent configuration
|
|
|
|
|
- Added feature flag to always enable annotations
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.10.0 <small>_ July 10, 2021</small> { id="2.10.0" }
|
2021-07-10 16:27:48 +03:00
|
|
|
|
|
|
|
|
- Added support for cookie consent
|
|
|
|
|
- Fixed #2807: Back-to-top button not hidden when using sticky tabs
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.9.2 <small>_ May 30, 2021</small> { id="2.9.2" }
|
2021-05-30 17:04:25 +03:00
|
|
|
|
|
|
|
|
- Moved tags to partial for easier customization
|
|
|
|
|
- Added support for hiding tags on any page
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.9.1 <small>_ May 24, 2021</small> { id="2.9.1" }
|
2021-05-30 14:58:19 +03:00
|
|
|
|
|
|
|
|
- Added missing guard for linking of content tabs
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.9.0 <small>_ May 23, 2021</small> { id="2.9.0" }
|
2021-05-23 14:30:26 +03:00
|
|
|
|
|
|
|
|
- Added support for linking of content tabs
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.8.0 <small>_ May 12, 2021</small> { id="2.8.0" }
|
2021-05-12 10:31:07 +03:00
|
|
|
|
|
|
|
|
- Added support for boosting pages in search
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.7.2 <small>_ May 8, 2021</small> { id="2.7.2" }
|
2021-05-08 11:32:28 +03:00
|
|
|
|
|
|
|
|
- Fixed #2638: Warnings shown when using `tags` plugin without directory URLs
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.7.1 <small>_ May 3, 2021</small> { id="2.7.1" }
|
2021-05-03 13:29:45 +03:00
|
|
|
|
|
|
|
|
- Fixed `git-revision-date-localized` plugin integration (2.7.0 regression)
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.7.0 <small>_ May 1, 2021</small> { id="2.7.0" }
|
2021-05-01 18:53:39 +03:00
|
|
|
|
|
|
|
|
- Added support for tags (with search integration)
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.6.0 <small>_ April 11, 2021</small> { id="2.6.0" }
|
2021-04-11 19:09:04 +03:00
|
|
|
|
|
|
|
|
- Stay on page when switching versions
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.5.0 <small>_ March 28, 2021</small> { id="2.5.0" }
|
2021-03-28 20:46:59 +03:00
|
|
|
|
|
|
|
|
- Added support for version warning
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.4.0 <small>_ March 20, 2021</small> { id="2.4.0" }
|
2021-03-20 14:55:26 +03:00
|
|
|
|
|
|
|
|
- Added support for custom admonition icons
|
|
|
|
|
- Fixed #2444: Code block annotations with extra comments have wrong index
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.3.1 <small>_ March 14, 2021</small> { id="2.3.1" }
|
2021-03-14 16:57:50 +03:00
|
|
|
|
|
|
|
|
- Fixed anchor offset for permalinks when using sticky navigation tabs
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.3.0 <small>_ March 13, 2021</small> { id="2.3.0" }
|
2021-03-13 16:28:43 +03:00
|
|
|
|
2021-03-14 16:57:50 +03:00
|
|
|
- Added support for back-to-top button
|
2021-03-13 16:28:43 +03:00
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.2.1 <small>_ March 4, 2021</small> { id="2.2.1" }
|
2021-03-04 21:48:25 +03:00
|
|
|
|
|
|
|
|
- Fixed #2382: Repository stats failing when no release tag is present
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.2.0 <small>_ February 28, 2021</small> { id="2.2.0" }
|
2021-03-04 20:35:48 +03:00
|
|
|
|
|
|
|
|
- Added support for code block annotations
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.1.0 <small>_ February 26, 2021</small> { id="2.1.0" }
|
2021-02-26 20:56:25 +03:00
|
|
|
|
|
|
|
|
- Added support for anchor tracking
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 2.0.0 <small>_ February 24, 2021</small> { id="2.0.0" }
|
2021-02-24 20:59:12 +03:00
|
|
|
|
|
|
|
|
- Migrated Insiders to the new architecture
|
|
|
|
|
- Swapped color palette toggle configuration
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.17.0 <small>_ January 31, 2021</small> { id="1.17.0" }
|
2021-01-31 18:30:57 +03:00
|
|
|
|
|
|
|
|
- Added support for section index pages
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.16.1 <small>_ January 26, 2021</small> { id="1.16.1" }
|
2021-01-26 12:56:46 +03:00
|
|
|
|
|
|
|
|
- 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
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.16.0 <small>_ January 7, 2021</small> { id="1.16.0" }
|
2021-01-17 14:42:46 +03:00
|
|
|
|
|
|
|
|
- Added latest release to repository info (GitHub)
|
2021-01-17 15:05:37 +03:00
|
|
|
- Slight facelift of repository info (lighter fonts, spacing and icons)
|
2021-01-17 14:42:46 +03:00
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.15.0 <small>_ January 2, 2021</small> { id="1.15.0" }
|
2021-01-02 17:57:02 +03:00
|
|
|
|
|
|
|
|
- Added support for native Mermaid.js integration
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.14.0 <small>_ December 30, 2020</small> { id="1.14.0" }
|
2020-12-30 21:02:02 +03:00
|
|
|
|
|
|
|
|
- Added support for sharing searches
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.13.2 <small>_ December 22, 2020</small> { id="1.13.2" }
|
2020-12-22 16:37:15 +03:00
|
|
|
|
|
|
|
|
- Fixed version selector + sticky tabs navigation rendering issues
|
|
|
|
|
- Fixed version selector wrapping
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.13.1 <small>_ December 20, 2020</small> { id="1.13.1" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Removed horizontal scrollbars on language and version selector
|
|
|
|
|
- Fixed type conversion in JavaScript config
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.13.0 <small>_ December 13, 2020</small> { id="1.13.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- 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
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.12.1 <small>_ December 8, 2020</small> { id="1.12.1" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Fixed empty language selector being shown
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.12.0 <small>_ December 6, 2020</small> { id="1.12.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for adding a language selector
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.11.2 <small>_ November 29, 2020</small> { id="1.11.2" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Fixed #2068: Search highlight interprets code blocks as JavaScript
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.11.1 <small>_ November 29, 2020</small> { id="1.11.1" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Refactored styling to be more stable and easier to adjust
|
|
|
|
|
- Fixed some styling regressions from latest features
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.11.0 <small>_ November 22, 2020</small> { id="1.11.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for rendering admonitions as inline blocks
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.10.0 <small>_ November 15, 2020</small> { id="1.10.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for integrating table of contents into navigation
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.9.0 <small>_ November 7, 2020</small> { id="1.9.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for hiding navigation and table of contents on any page
|
|
|
|
|
- Removed autohiding table of contents when empty
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.8.0 <small>_ November 1, 2020</small> { id="1.8.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for navigation sections
|
|
|
|
|
- Fixed appearance of inactive search suggestions
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.7.0 <small>_ October 25, 2020</small> { id="1.7.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for deploying multiple versions
|
|
|
|
|
- Fixed alignment of sidebar when content area is too small
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.6.0 <small>_ October 11, 2020</small> { id="1.6.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- 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++
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.5.1 <small>_ September 21, 2020</small> { id="1.5.1" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Fixed content area stretching to whole width for long code blocks
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.5.0 <small>_ September 19, 2020</small> { id="1.5.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for autohiding table of contents when empty
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.4.1 <small>_ September 6, 2020</small> { id="1.4.1" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Improved typeahead and search result relevance and scoring
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.4.0 <small>_ August 30, 2020</small> { id="1.4.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for autohiding header on scroll
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.3.0 <small>_ August 26, 2020</small> { id="1.3.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added support for user-selectable color palettes
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.2.0 <small>_ August 11, 2020</small> { id="1.2.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added feature to expand navigation by default
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.1.0 <small>_ August 3, 2020</small> { id="1.1.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added highlighting of search results
|
|
|
|
|
|
2021-10-11 15:14:04 +03:00
|
|
|
### 1.0.0 <small>_ July 14, 2020</small> { id="1.0.0" }
|
2020-12-21 19:38:58 +03:00
|
|
|
|
|
|
|
|
- Added grouping of search results
|
|
|
|
|
- Added missing query terms to search result
|
|
|
|
|
- Improved search result relevance and scoring
|
