Prepare 3.3.0 release

This commit is contained in:
squidfunk 2019-01-29 11:07:18 +01:00
parent 3522c69c94
commit d25fcefd9f
5 changed files with 101 additions and 235 deletions

View File

@ -1,4 +1,4 @@
mkdocs-material-3.x.x (2019-xx-xx) mkdocs-material-3.3.0 (2019-01-29)
* Moved Google Analytics integration into `head` using Google Tag Manager * Moved Google Analytics integration into `head` using Google Tag Manager
* Fixed #972: Unicode slugifier breaks table of contents blur on scroll * Fixed #972: Unicode slugifier breaks table of contents blur on scroll

View File

@ -22,9 +22,9 @@ pip show mkdocs-material
* All extended templates *should* continue to work but in order to make them * All extended templates *should* continue to work but in order to make them
future-proof the `url` filter should be introduced on all paths. Please see future-proof the `url` filter should be introduced on all paths. Please see
the [official release notes][_1] for further guidance. the [official release notes][1] for further guidance.
[_1]: https://www.mkdocs.org/about/release-notes/#version-10-2018-08-03 [1]: https://www.mkdocs.org/about/release-notes/#version-10-2018-08-03
### Material 1.x to 2.x ### Material 1.x to 2.x
@ -49,60 +49,49 @@ pip show mkdocs-material
## Changelog ## Changelog
### 3.3.0 <small>_ January 29, 2019</small>
* 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 <small>_ December 28, 2018</small> ### 3.2.0 <small>_ December 28, 2018</small>
* Added support for redirects using metadata refresh * Added support for redirects using metadata refresh
* Fixed [#921][921]: Load Google Analytics snippet asynchronously * Fixed #921: Load Google Analytics snippet asynchronously
[921]: https://github.com/squidfunk/mkdocs-material/issues/921
### 3.1.0 <small>_ November 17, 2018</small> ### 3.1.0 <small>_ November 17, 2018</small>
* Added support for Progressive Web App Manifest * Added support for Progressive Web App Manifest
* Fixed [#915][915]: Search bug in Safari (upgraded Lunr.js) * Fixed #915: Search bug in Safari (upgraded Lunr.js)
[915]: https://github.com/squidfunk/mkdocs-material/issues/915
### 3.0.6 <small>_ October 26, 2018</small> ### 3.0.6 <small>_ October 26, 2018</small>
* Added Taiwanese translations * Added Taiwanese translations
* Fixed [#906][906]: JavaScript code blocks evaluated in search results * Fixed #906: JavaScript code blocks evaluated in search results
[906]: https://github.com/squidfunk/mkdocs-material/issues/906
### 3.0.5 <small>_ October 23, 2018</small> ### 3.0.5 <small>_ October 23, 2018</small>
* Added Croatian and Indonesian translations * Added Croatian and Indonesian translations
* Fixed [#899][899]: Skip-to-content link invalid from 2nd level on * Fixed #899: Skip-to-content link invalid from 2nd level on
* Fixed [#902][902]: Missing URL filter in footer for FontAwesome link * Fixed #902: Missing URL filter in footer for FontAwesome link
[899]: https://github.com/squidfunk/mkdocs-material/issues/899
[902]: https://github.com/squidfunk/mkdocs-material/issues/902
### 3.0.4 <small>_ September 3, 2018</small> ### 3.0.4 <small>_ September 3, 2018</small>
* Updated Dutch translations * Updated Dutch translations
* Fixed [#856][856]: Removef preconnect meta tag if Google Fonts are disabled * Fixed #856: Removef preconnect meta tag if Google Fonts are disabled
[856]: https://github.com/squidfunk/mkdocs-material/issues/856
### 3.0.3 <small>_ August 7, 2018</small> ### 3.0.3 <small>_ August 7, 2018</small>
* Fixed [#841][841]: Additional path levels for extra CSS and JS * Fixed #841: Additional path levels for extra CSS and JS
[841]: https://github.com/squidfunk/mkdocs-material/issues/841
### 3.0.2 <small>_ August 6, 2018</small> ### 3.0.2 <small>_ August 6, 2018</small>
* Fixed [#839][839]: Lunr.js stemmer imports incorrect * Fixed #839: Lunr.js stemmer imports incorrect
[839]: https://github.com/squidfunk/mkdocs-material/issues/839
### 3.0.1 <small>_ August 5, 2018</small> ### 3.0.1 <small>_ August 5, 2018</small>
* Fixed [#838][838]: Search result links incorrect * Fixed #838: Search result links incorrect
[838]: https://github.com/squidfunk/mkdocs-material/issues/838
### 3.0.0 <small>_ August 5, 2018</small> ### 3.0.0 <small>_ August 5, 2018</small>
@ -126,18 +115,13 @@ pip show mkdocs-material
### 2.9.1 <small>_ June 18, 2018</small> ### 2.9.1 <small>_ June 18, 2018</small>
* Added support for different spellings for theme color * Added support for different spellings for theme color
* Fixed [#799][799]: Added support for web font minification in production * Fixed #799: Added support for web font minification in production
* Fixed [#800][800]: Added `.highlighttable` as an alias for `.codehilitetable` * Fixed #800: Added `.highlighttable` as an alias for `.codehilitetable`
[799]: https://github.com/squidfunk/mkdocs-material/issues/799
[800]: https://github.com/squidfunk/mkdocs-material/issues/800
### 2.9.0 <small>_ June 13, 2018</small> ### 2.9.0 <small>_ June 13, 2018</small>
* Added support for theme color on Android * Added support for theme color on Android
* Fixed [#796][796]: Rendering of nested tabbed code blocks * Fixed #796: Rendering of nested tabbed code blocks
[796]: https://github.com/squidfunk/mkdocs-material/issues/796
### 2.8.0 <small>_ June 10, 2018</small> ### 2.8.0 <small>_ June 10, 2018</small>
@ -145,9 +129,7 @@ pip show mkdocs-material
* Added Material and FontAwesome icon fonts to distribution files (GDPR) * Added Material and FontAwesome icon fonts to distribution files (GDPR)
* Added note on compliance with GDPR * Added note on compliance with GDPR
* Added Slovak translations * Added Slovak translations
* Fixed [#790][790]: Prefixed `id` attributes with `__` to avoid name clashes * Fixed #790: Prefixed `id` attributes with `__` to avoid name clashes
[790]: https://github.com/squidfunk/mkdocs-material/issues/790
### 2.7.3 <small>_ April 26, 2018</small> ### 2.7.3 <small>_ April 26, 2018</small>
@ -160,11 +142,8 @@ pip show mkdocs-material
### 2.7.1 <small>_ March 21, 2018</small> ### 2.7.1 <small>_ March 21, 2018</small>
* Added Galician translations * Added Galician translations
* Fixed [#730][730]: Scroll chasing error on home page if Disqus is enabled * Fixed #730: Scroll chasing error on home page if Disqus is enabled
* Fixed [#736][736]: Reset drawer and search upon back button invocation * Fixed #736: Reset drawer and search upon back button invocation
[730]: https://github.com/squidfunk/mkdocs-material/issues/730
[736]: https://github.com/squidfunk/mkdocs-material/issues/736
### 2.7.0 <small>_ March 6, 2018</small> ### 2.7.0 <small>_ March 6, 2018</small>
@ -174,9 +153,7 @@ pip show mkdocs-material
### 2.6.6 <small>_ February 22, 2018</small> ### 2.6.6 <small>_ February 22, 2018</small>
* Added preconnect for Google Fonts for faster loading * Added preconnect for Google Fonts for faster loading
* Fixed [#710][710]: With tabs sidebar disappears if JavaScript is not available * Fixed #710: With tabs sidebar disappears if JavaScript is not available
[710]: https://github.com/squidfunk/mkdocs-material/issues/710
### 2.6.5 <small>_ February 22, 2018</small> ### 2.6.5 <small>_ February 22, 2018</small>
@ -203,13 +180,10 @@ pip show mkdocs-material
### 2.6.1 <small>_ February 11, 2018</small> ### 2.6.1 <small>_ February 11, 2018</small>
* Added ability to override Disqus integration using metadata * Added ability to override Disqus integration using metadata
* Fixed [#690][690]: Duplicate slashes in source file URLs * Fixed #690: Duplicate slashes in source file URLs
* Fixed [#696][696]: Active page highlight not working with default palette * Fixed #696: Active page highlight not working with default palette
* Adjusted German translations * Adjusted German translations
[690]: https://github.com/squidfunk/mkdocs-material/issues/690
[696]: https://github.com/squidfunk/mkdocs-material/issues/696
### 2.6.0 <small>_ February 2, 2018</small> ### 2.6.0 <small>_ February 2, 2018</small>
* Moved default search configuration to default translation (English) * Moved default search configuration to default translation (English)
@ -226,9 +200,7 @@ pip show mkdocs-material
### 2.5.4 <small>_ January 29, 2018</small> ### 2.5.4 <small>_ January 29, 2018</small>
* Fixed [#683][683]: `gh-deploy` fails inside Docker * Fixed #683: `gh-deploy` fails inside Docker
[683]: https://github.com/squidfunk/mkdocs-material/issues/683
### 2.5.3 <small>_ January 25, 2018</small> ### 2.5.3 <small>_ January 25, 2018</small>
@ -237,11 +209,8 @@ pip show mkdocs-material
### 2.5.2 <small>_ January 22, 2018</small> ### 2.5.2 <small>_ January 22, 2018</small>
* Added default search language mappings for all localizations * Added default search language mappings for all localizations
* Fixed [#673][673]: Error loading non-existent search language * Fixed #673: Error loading non-existent search language
* Fixed [#675][675]: Uncaught reference error when search plugin disabled * Fixed #675: Uncaught reference error when search plugin disabled
[673]: https://github.com/squidfunk/mkdocs-material/issues/673
[675]: https://github.com/squidfunk/mkdocs-material/issues/675
### 2.5.1 <small>_ January 20, 2018</small> ### 2.5.1 <small>_ January 20, 2018</small>
@ -256,7 +225,7 @@ pip show mkdocs-material
### 2.4.0 <small>_ January 11, 2018</small> ### 2.4.0 <small>_ January 11, 2018</small>
* Added focus state for clipboard buttons * Added focus state for clipboard buttons
* Fixed [#400][400]: Search bar steals tab focus * Fixed #400: Search bar steals tab focus
* Fixed search not closing on ++enter++ when result is selected * Fixed search not closing on ++enter++ when result is selected
* Fixed search not closing when losing focus due to ++tab++ * Fixed search not closing when losing focus due to ++tab++
* Fixed collapsed navigation links getting focus * Fixed collapsed navigation links getting focus
@ -266,8 +235,6 @@ pip show mkdocs-material
* Removed `outline` resets for links * Removed `outline` resets for links
* Improved general tabbing behavior on desktop * Improved general tabbing behavior on desktop
[400]: https://github.com/squidfunk/mkdocs-material/issues/400
### 2.3.0 <small>_ January 9, 2018</small> ### 2.3.0 <small>_ January 9, 2018</small>
* Added `example` (synonym: `snippet`) style for Admonition * Added `example` (synonym: `snippet`) style for Admonition
@ -280,23 +247,17 @@ pip show mkdocs-material
### 2.2.5 <small>_ December 18, 2017</small> ### 2.2.5 <small>_ December 18, 2017</small>
* Fixed [#639][639]: Broken default favicon * Fixed #639: Broken default favicon
[639]: https://github.com/squidfunk/mkdocs-material/issues/639
### 2.2.4 <small>_ December 18, 2017</small> ### 2.2.4 <small>_ December 18, 2017</small>
* Fixed [#638][638]: Build breaks with Jinja < 2.9 * Fixed #638: Build breaks with Jinja < 2.9
[638]: https://github.com/squidfunk/mkdocs-material/issues/638
### 2.2.3 <small>_ December 13, 2017</small> ### 2.2.3 <small>_ December 13, 2017</small>
* Fixed [#630][630]: Admonition sets padding on any last child * Fixed #630: Admonition sets padding on any last child
* Adjusted Chinese (Traditional) translations * Adjusted Chinese (Traditional) translations
[630]: https://github.com/squidfunk/mkdocs-material/issues/630
### 2.2.2 <small>_ December 8, 2017</small> ### 2.2.2 <small>_ December 8, 2017</small>
* Added Dutch translations * Added Dutch translations
@ -305,20 +266,15 @@ pip show mkdocs-material
### 2.2.1 <small>_ December 2, 2017</small> ### 2.2.1 <small>_ December 2, 2017</small>
* Fixed [#616][616]: Minor styling error with title-only admonition blocks * Fixed #616: Minor styling error with title-only admonition blocks
* Removed border for table of contents and improved spacing * Removed border for table of contents and improved spacing
[616]: https://github.com/squidfunk/mkdocs-material/issues/616
### 2.2.0 <small>_ November 22, 2017</small> ### 2.2.0 <small>_ November 22, 2017</small>
* Added support for hero teaser * Added support for hero teaser
* Added Portuguese translations * Added Portuguese translations
* Fixed [#586][586]: Footnote backref target offset regression * Fixed #586: Footnote backref target offset regression
* Fixed [#605][605]: Search stemmers not correctly loaded * Fixed #605: Search stemmers not correctly loaded
[586]: https://github.com/squidfunk/mkdocs-material/issues/586
[605]: https://github.com/squidfunk/mkdocs-material/issues/605
### 2.1.1 <small>_ November 21, 2017</small> ### 2.1.1 <small>_ November 21, 2017</small>
@ -344,23 +300,17 @@ pip show mkdocs-material
### 2.0.3 <small>_ November 5, 2017</small> ### 2.0.3 <small>_ November 5, 2017</small>
* Added Japanese translations * Added Japanese translations
* Fixed [#540][540]: Jumping to anchor inside `details` doesn't open it * Fixed #540: Jumping to anchor inside `details` doesn't open it
* Fixed active link colors in footer * Fixed active link colors in footer
[540]: https://github.com/squidfunk/mkdocs-material/issues/540
### 2.0.2 <small>_ November 1, 2017</small> ### 2.0.2 <small>_ November 1, 2017</small>
* Added Russian translations * Added Russian translations
* Fixed [#542][542]: Horizontal scrollbar between `1220px` and `1234px` * Fixed #542: Horizontal scrollbar between `1220px` and `1234px`
* Fixed [#553][553]: Metadata values only rendering first character * Fixed #553: Metadata values only rendering first character
* Fixed [#558][558]: Flash of unstyled content * Fixed #558: Flash of unstyled content
* Fixed favicon regression caused by deprecation upstream * Fixed favicon regression caused by deprecation upstream
[542]: https://github.com/squidfunk/mkdocs-material/issues/542
[553]: https://github.com/squidfunk/mkdocs-material/issues/553
[558]: https://github.com/squidfunk/mkdocs-material/issues/558
### 2.0.1 <small>_ October 31, 2017</small> ### 2.0.1 <small>_ October 31, 2017</small>
* Fixed error when initializing search * Fixed error when initializing search
@ -384,18 +334,14 @@ pip show mkdocs-material
* Added Polish, Swedish and Spanish translations * Added Polish, Swedish and Spanish translations
* Improved downward compatibility with custom partials * Improved downward compatibility with custom partials
* Temporarily pinned MkDocs version within Docker image to 0.16.3 * Temporarily pinned MkDocs version within Docker image to 0.16.3
* Fixed [#519][519]: Missing theme configuration file * Fixed #519: Missing theme configuration file
[519]: https://github.com/squidfunk/mkdocs-material/issues/519
### 1.12.0 <small>_ October 20, 2017</small> ### 1.12.0 <small>_ October 20, 2017</small>
* Added support for setting language(s) via `mkdocs.yml` * Added support for setting language(s) via `mkdocs.yml`
* Added support for default localization * Added support for default localization
* Added German and Danish translations * Added German and Danish translations
* Fixed [#374][374]: Search bar misalignment on big screens * Fixed #374: Search bar misalignment on big screens
[374]: https://github.com/squidfunk/mkdocs-material/issues/374
### 1.11.0 <small>_ October 19, 2017</small> ### 1.11.0 <small>_ October 19, 2017</small>
@ -406,29 +352,20 @@ pip show mkdocs-material
* Improved print styles of code blocks * Improved print styles of code blocks
* Improved search UX (don't close on enter if no selection) * Improved search UX (don't close on enter if no selection)
* Fixed [#495][495]: Vertical scrollbar on short pages * Fixed #495: Vertical scrollbar on short pages
[495]: https://github.com/squidfunk/mkdocs-material/issues/495
### 1.10.3 <small>_ October 11, 2017</small> ### 1.10.3 <small>_ October 11, 2017</small>
* Fixed [#484][484]: Vertical scrollbar on some MathJax formulas * Fixed #484: Vertical scrollbar on some MathJax formulas
* Fixed [#483][483]: Footnote backref target offset regression * Fixed #483: Footnote backref target offset regression
[483]: https://github.com/squidfunk/mkdocs-material/issues/483
[484]: https://github.com/squidfunk/mkdocs-material/issues/484
### 1.10.2 <small>_ October 6, 2017</small> ### 1.10.2 <small>_ October 6, 2017</small>
* Fixed [#468][468]: Sidebar shows scrollbar if content is shorter (in Safari) * Fixed #468: Sidebar shows scrollbar if content is shorter (in Safari)
[468]: https://github.com/squidfunk/mkdocs-material/issues/468
### 1.10.1 <small>_ September 14, 2017</small> ### 1.10.1 <small>_ September 14, 2017</small>
* Fixed [#455][455]: Bold code blocks rendered with normal font weight * Fixed #455: Bold code blocks rendered with normal font weight
[455]: https://github.com/squidfunk/mkdocs-material/issues/455
### 1.10.0 <small>_ September 1, 2017</small> ### 1.10.0 <small>_ September 1, 2017</small>
@ -450,35 +387,26 @@ pip show mkdocs-material
### 1.8.1 <small>_ August 7, 2017</small> ### 1.8.1 <small>_ August 7, 2017</small>
* Fixed [#421][421]: Missing pagination for GitHub API * Fixed #421: Missing pagination for GitHub API
[421]: https://github.com/squidfunk/mkdocs-material/issues/421
### 1.8.0 <small>_ August 2, 2017</small> ### 1.8.0 <small>_ August 2, 2017</small>
* Added support for lazy-loading of search results for better performance * Added support for lazy-loading of search results for better performance
* Added support for customization of search tokenizer/separator * Added support for customization of search tokenizer/separator
* Fixed [#424][424]: Search doesn't handle capital letters anymore * Fixed #424: Search doesn't handle capital letters anymore
* Fixed [#419][419]: Search doesn't work on whole words * Fixed #419: Search doesn't work on whole words
[419]: https://github.com/squidfunk/mkdocs-material/issues/419
[424]: https://github.com/squidfunk/mkdocs-material/issues/424
### 1.7.5 <small>_ July 25, 2017</small> ### 1.7.5 <small>_ July 25, 2017</small>
* Fixed [#398][398]: Forms broken due to search shortcuts * Fixed #398: Forms broken due to search shortcuts
* Improved search overall user experience * Improved search overall user experience
* Improved search matching and highlighting * Improved search matching and highlighting
* Improved search accessibility * Improved search accessibility
[398]: https://github.com/squidfunk/mkdocs-material/issues/398
### 1.7.4 <small>_ June 21, 2017</small> ### 1.7.4 <small>_ June 21, 2017</small>
* Fixed functional link colors in table of contents for active palette * Fixed functional link colors in table of contents for active palette
* Fixed [#368][368]: Compatibility issues with IE11 * Fixed #368: Compatibility issues with IE11
[368]: https://github.com/squidfunk/mkdocs-material/issues/368
### 1.7.3 <small>_ June 7, 2017</small> ### 1.7.3 <small>_ June 7, 2017</small>
@ -502,28 +430,20 @@ pip show mkdocs-material
### 1.6.4 <small>_ May 24, 2017</small> ### 1.6.4 <small>_ May 24, 2017</small>
* Fixed [#337][337]: JavaScript error for GitHub organization URLs * Fixed #337: JavaScript error for GitHub organization URLs
[337]: https://github.com/squidfunk/mkdocs-material/issues/337
### 1.6.3 <small>_ May 16, 2017</small> ### 1.6.3 <small>_ May 16, 2017</small>
* Fixed [#329][329]: Broken source stats for private or unknown GitHub repos * Fixed #329: Broken source stats for private or unknown GitHub repos
[329]: https://github.com/squidfunk/mkdocs-material/issues/329
### 1.6.2 <small>_ May 15, 2017</small> ### 1.6.2 <small>_ May 15, 2017</small>
* Fixed [#316][316]: Fatal error for git clone on Windows * Fixed #316: Fatal error for git clone on Windows
* Fixed [#320][320]: Chrome 58 creates double underline for `abbr` tags * Fixed #320: Chrome 58 creates double underline for `abbr` tags
* Fixed [#323][323]: Ligatures rendered inside code blocks * Fixed #323: Ligatures rendered inside code blocks
* Fixed miscalculated sidebar height due to missing margin collapse * Fixed miscalculated sidebar height due to missing margin collapse
* Changed deprecated MathJax CDN to Cloudflare * Changed deprecated MathJax CDN to Cloudflare
[316]: https://github.com/squidfunk/mkdocs-material/issues/316
[320]: https://github.com/squidfunk/mkdocs-material/issues/320
[323]: https://github.com/squidfunk/mkdocs-material/issues/323
### 1.6.1 <small>_ April 23, 2017</small> ### 1.6.1 <small>_ April 23, 2017</small>
* Fixed following of active/focused element if search input is focused * Fixed following of active/focused element if search input is focused
@ -534,17 +454,13 @@ pip show mkdocs-material
* Added build test for Docker image on Travis * Added build test for Docker image on Travis
* Added search overlay for better user experience (focus) * Added search overlay for better user experience (focus)
* Added language from localizations to `html` tag * Added language from localizations to `html` tag
* Fixed [#270][270]: source links broken for absolute URLs * Fixed #270: source links broken for absolute URLs
* Fixed missing top spacing for first targeted element in content * Fixed missing top spacing for first targeted element in content
* Fixed too small footnote divider when using larger font sizes * Fixed too small footnote divider when using larger font sizes
[270]: https://github.com/squidfunk/mkdocs-material/issues/270
### 1.5.5 <small>_ April 20, 2017</small> ### 1.5.5 <small>_ April 20, 2017</small>
* Fixed [#282][282]: Browser search (<kbd>Meta</kbd>+<kbd>F</kbd>) is hijacked * Fixed #282: Browser search (<kbd>Meta</kbd>+<kbd>F</kbd>) is hijacked
[282]: https://github.com/squidfunk/mkdocs-material/issues/282
### 1.5.4 <small>_ April 8, 2017</small> ### 1.5.4 <small>_ April 8, 2017</small>
@ -568,9 +484,7 @@ pip show mkdocs-material
### 1.5.1 <small>_ March 30, 2017</small> ### 1.5.1 <small>_ March 30, 2017</small>
* Fixed rendering and offset of targetted footnotes * Fixed rendering and offset of targetted footnotes
* Fixed [#238][238]: Link on logo is not set to `site_url` * Fixed #238: Link on logo is not set to `site_url`
[238]: https://github.com/squidfunk/mkdocs-material/issues/238
### 1.5.0 <small>_ March 24, 2017</small> ### 1.5.0 <small>_ March 24, 2017</small>
@ -581,13 +495,10 @@ pip show mkdocs-material
* Added git hook to skip CI build on non-src changes * Added git hook to skip CI build on non-src changes
* Fixed non-resetting search placeholder when input is cleared * Fixed non-resetting search placeholder when input is cleared
* Fixed error for unescaped parentheses in search term * Fixed error for unescaped parentheses in search term
* Fixed [#229][229]: Button to clear search missing * Fixed #229: Button to clear search missing
* Fixed [#231][231]: Escape key doesn't exit search * Fixed #231: Escape key doesn't exit search
* Removed old-style figures from font feature settings * Removed old-style figures from font feature settings
[229]: https://github.com/squidfunk/mkdocs-material/issues/229
[231]: https://github.com/squidfunk/mkdocs-material/issues/231
### 1.4.1 <small>_ March 16, 2017</small> ### 1.4.1 <small>_ March 16, 2017</small>
* Fixed invalid destructuring attempt on NodeList (in Safari, Edge, IE) * Fixed invalid destructuring attempt on NodeList (in Safari, Edge, IE)
@ -597,37 +508,31 @@ pip show mkdocs-material
* Added support for grouping searched sections by documents * Added support for grouping searched sections by documents
* Added support for highlighting of search terms * Added support for highlighting of search terms
* Added support for localization of search results * Added support for localization of search results
* Fixed [#216][216]: table of contents icon doesn't show if `h1` is not present * Fixed #216: table of contents icon doesn't show if `h1` is not present
* Reworked style and layout of search results for better usability * Reworked style and layout of search results for better usability
[216]: https://github.com/squidfunk/mkdocs-material/issues/216
### 1.3.0 <small>_ March 11, 2017</small> ### 1.3.0 <small>_ March 11, 2017</small>
* Added support for page-specific title and description using metadata * Added support for page-specific title and description using metadata
* Added support for linking source files to documentation * Added support for linking source files to documentation
* Fixed jitter and offset of sidebar when zooming browser * Fixed jitter and offset of sidebar when zooming browser
* Fixed incorrectly initialized tablet sidebar height * Fixed incorrectly initialized tablet sidebar height
* Fixed regression for [#1][1]: GitHub stars break if `repo_url` ends with a `/` * Fixed regression for #1: GitHub stars break if `repo_url` ends with a `/`
* Fixed undesired white line below copyright footer due to base font scaling * Fixed undesired white line below copyright footer due to base font scaling
* Fixed issue with whitespace in path for scripts * Fixed issue with whitespace in path for scripts
* Fixed [#205][205]: support non-fixed (static) header * Fixed #205: support non-fixed (static) header
* Refactored footnote references for better visibility * Refactored footnote references for better visibility
* Reduced repaints to a minimum for non-tabs configuration * Reduced repaints to a minimum for non-tabs configuration
* Reduced contrast of edit button (slightly) * Reduced contrast of edit button (slightly)
[205]: https://github.com/squidfunk/mkdocs-material/issues/205
### 1.2.0 <small>_ March 3, 2017</small> ### 1.2.0 <small>_ March 3, 2017</small>
* Added `quote` (synonym: `cite`) style for Admonition * Added `quote` (synonym: `cite`) style for Admonition
* Added help message to build pipeline * Added help message to build pipeline
* Fixed wrong navigation link colors when applying palette * Fixed wrong navigation link colors when applying palette
* Fixed [#197][197]: Link missing in tabs navigation on deeply nested items * Fixed #197: Link missing in tabs navigation on deeply nested items
* Removed unnecessary dev dependencies * Removed unnecessary dev dependencies
[197]: https://github.com/squidfunk/mkdocs-material/issues/197
### 1.1.1 <small>_ February 26, 2017</small> ### 1.1.1 <small>_ February 26, 2017</small>
* Fixed incorrectly displayed nested lists when using tabs * Fixed incorrectly displayed nested lists when using tabs
@ -638,8 +543,8 @@ pip show mkdocs-material
* Added Disqus integration (optional) * Added Disqus integration (optional)
* Added a high resolution Favicon with the new logo * Added a high resolution Favicon with the new logo
* Added static type checking using Facebook's Flow * Added static type checking using Facebook's Flow
* Fixed [#173][173]: Dictionary elements have no bottom spacing * Fixed #173: Dictionary elements have no bottom spacing
* Fixed [#175][175]: Tables cannot be set to 100% width * Fixed #175: Tables cannot be set to 100% width
* Fixed race conditions in build related to asset revisioning * Fixed race conditions in build related to asset revisioning
* Fixed accidentally re-introduced Permalink on top-level headline * Fixed accidentally re-introduced Permalink on top-level headline
* Fixed alignment of logo in drawer on IE11 * Fixed alignment of logo in drawer on IE11
@ -647,40 +552,27 @@ pip show mkdocs-material
* Refactored and automated Docker build and PyPI release * Refactored and automated Docker build and PyPI release
* Refactored build scripts * Refactored build scripts
[173]: https://github.com/squidfunk/mkdocs-material/issues/173
[175]: https://github.com/squidfunk/mkdocs-material/issues/175
### 1.0.5 <small>_ February 18, 2017</small> ### 1.0.5 <small>_ February 18, 2017</small>
* Fixed [#153][153]: Sidebar flows out of constrained area in Chrome 56 * Fixed #153: Sidebar flows out of constrained area in Chrome 56
* Fixed [#159][159]: Footer jitter due to JavaScript if content is short * Fixed #159: Footer jitter due to JavaScript if content is short
[153]: https://github.com/squidfunk/mkdocs-material/issues/153
[159]: https://github.com/squidfunk/mkdocs-material/issues/159
### 1.0.4 <small>_ February 16, 2017</small> ### 1.0.4 <small>_ February 16, 2017</small>
* Fixed [#142][142]: Documentation build errors if `h1` is defined as raw HTML * Fixed #142: Documentation build errors if `h1` is defined as raw HTML
* Fixed [#164][164]: PyPI release does not build and install * Fixed #164: PyPI release does not build and install
* Fixed offsets of targeted headlines * Fixed offsets of targeted headlines
* Increased sidebar font size by `0.12rem` * Increased sidebar font size by `0.12rem`
[142]: https://github.com/squidfunk/mkdocs-material/issues/142
[164]: https://github.com/squidfunk/mkdocs-material/issues/164
### 1.0.3 <small>_ January 22, 2017</small> ### 1.0.3 <small>_ January 22, 2017</small>
* Fixed [#117][117]: Table of contents items don't blur on fast scrolling * Fixed #117: Table of contents items don't blur on fast scrolling
* Refactored sidebar positioning logic * Refactored sidebar positioning logic
* Further reduction of repaints * Further reduction of repaints
[117]: https://github.com/squidfunk/mkdocs-material/issues/117
### 1.0.2 <small>_ January 15, 2017</small> ### 1.0.2 <small>_ January 15, 2017</small>
* Fixed [#108][108]: Horizontal scrollbar in content area * Fixed #108: Horizontal scrollbar in content area
[108]: https://github.com/squidfunk/mkdocs-material/issues/108
### 1.0.1 <small>_ January 14, 2017</small> ### 1.0.1 <small>_ January 14, 2017</small>
@ -721,71 +613,45 @@ pip show mkdocs-material
### 0.2.4 <small>_ June 26, 2016</small> ### 0.2.4 <small>_ June 26, 2016</small>
* Fixed improperly set default favicon * Fixed improperly set default favicon
* Fixed [#33][33]: Protocol relative URL for webfonts doesn't work with * Fixed #33: Protocol relative URL for webfonts doesn't work with `file://`
`file://` * Fixed #34: IE11 on Windows 7 doesn't honor `max-width` on `main` tag
* Fixed [#34][34]: IE11 on Windows 7 doesn't honor `max-width` on `main` tag * Fixed #35: Add styling for blockquotes
* Fixed [#35][35]: Add styling for blockquotes
[33]: https://github.com/squidfunk/mkdocs-material/issues/25
[34]: https://github.com/squidfunk/mkdocs-material/issues/26
[35]: https://github.com/squidfunk/mkdocs-material/issues/30
### 0.2.3 <small>_ May 16, 2016</small> ### 0.2.3 <small>_ May 16, 2016</small>
* Fixed [#25][25]: Highlight inline fenced blocks * Fixed #25: Highlight inline fenced blocks
* Fixed [#26][26]: Better highlighting for keystrokes * Fixed #26: Better highlighting for keystrokes
* Fixed [#30][30]: Suboptimal syntax highlighting for PHP * Fixed #30: Suboptimal syntax highlighting for PHP
[25]: https://github.com/squidfunk/mkdocs-material/issues/25
[26]: https://github.com/squidfunk/mkdocs-material/issues/26
[30]: https://github.com/squidfunk/mkdocs-material/issues/30
### 0.2.2 <small>_ March 20, 2016</small> ### 0.2.2 <small>_ March 20, 2016</small>
* Fixed [#15][15]: Document Pygments dependency for CodeHilite * Fixed #15: Document Pygments dependency for CodeHilite
* Fixed [#16][16]: Favicon could not be set through `mkdocs.yml` * Fixed #16: Favicon could not be set through `mkdocs.yml`
* Fixed [#17][17]: Put version into own container for styling * Fixed #17: Put version into own container for styling
* Fixed [#20][20]: Fix rounded borders for tables * Fixed #20: Fix rounded borders for tables
[15]: https://github.com/squidfunk/mkdocs-material/issues/15
[16]: https://github.com/squidfunk/mkdocs-material/issues/16
[17]: https://github.com/squidfunk/mkdocs-material/issues/17
[20]: https://github.com/squidfunk/mkdocs-material/issues/20
### 0.2.1 <small>_ March 12, 2016</small> ### 0.2.1 <small>_ March 12, 2016</small>
* Fixed [#10][10]: Invisible header after closing search bar with * Fixed #10: Invisible header after closing search bar with <kbd>ESC</kbd> key
<kbd>ESC</kbd> key * Fixed #13: Table cells don't wrap
* Fixed [#13][13]: Table cells don't wrap
* Fixed empty list in table of contents when no headline is defined * Fixed empty list in table of contents when no headline is defined
* Corrected wrong path for static asset monitoring in Gulpfile.js * Corrected wrong path for static asset monitoring in Gulpfile.js
* Set up tracking of site search for Google Analytics * Set up tracking of site search for Google Analytics
[10]: https://github.com/squidfunk/mkdocs-material/issues/10
[13]: https://github.com/squidfunk/mkdocs-material/issues/13
### 0.2.0 <small>_ February 24, 2016</small> ### 0.2.0 <small>_ February 24, 2016</small>
* Fixed [#6][6]: Include multiple color palettes via `mkdocs.yml` * Fixed #6: Include multiple color palettes via `mkdocs.yml`
* Fixed [#7][7]: Better colors for links inside admonition notes and warnings * Fixed #7: Better colors for links inside admonition notes and warnings
* Fixed [#9][9]: Text for prev/next footer navigation should be customizable * Fixed #9: Text for prev/next footer navigation should be customizable
* Refactored templates (replaced `if`/`else` with modifiers where possible) * Refactored templates (replaced `if`/`else` with modifiers where possible)
[6]: https://github.com/squidfunk/mkdocs-material/issues/6
[7]: https://github.com/squidfunk/mkdocs-material/issues/7
[9]: https://github.com/squidfunk/mkdocs-material/issues/9
### 0.1.3 <small>_ February 21, 2016</small> ### 0.1.3 <small>_ February 21, 2016</small>
* Fixed [#3][3]: Ordered lists within an unordered list have `::before` content * Fixed #3: Ordered lists within an unordered list have `::before` content
* Fixed [#4][4]: Click on Logo/Title without Github-Repository: `"None"` * Fixed #4: Click on Logo/Title without Github-Repository: `"None"`
* Fixed [#5][5]: Page without headlines renders empty list in table of contents * Fixed #5: Page without headlines renders empty list in table of contents
* Moved Modernizr to top to ensure basic usability in IE8 * Moved Modernizr to top to ensure basic usability in IE8
[3]: https://github.com/squidfunk/mkdocs-material/issues/3
[4]: https://github.com/squidfunk/mkdocs-material/issues/4
[5]: https://github.com/squidfunk/mkdocs-material/issues/5
### 0.1.2 <small>_ February 16, 2016</small> ### 0.1.2 <small>_ February 16, 2016</small>
* Fixed styles for deep navigational hierarchies * Fixed styles for deep navigational hierarchies
@ -798,14 +664,11 @@ pip show mkdocs-material
### 0.1.1 <small>_ February 11, 2016</small> ### 0.1.1 <small>_ February 11, 2016</small>
* Fixed [#1][1]: GitHub stars don't work if the repo_url ends with a `/` * Fixed #1: GitHub stars don't work if the repo_url ends with a `/`
* Updated NPM and Bower dependencies to most recent versions * Updated NPM and Bower dependencies to most recent versions
* Changed footer/copyright link to Material theme to GitHub pages * Changed footer/copyright link to Material theme to GitHub pages
* Made MkDocs building/serving in build process optional * Made MkDocs building/serving in build process optional
* Set up continuous integration with [Travis][2] * Set up continuous integration with Travis
[1]: https://github.com/squidfunk/mkdocs-material/issues/1
[2]: https://travis-ci.org
### 0.1.0 <small>_ February 9, 2016</small> ### 0.1.0 <small>_ February 9, 2016</small>

View File

@ -41,7 +41,7 @@
<meta name="lang:{{ key }}" content="{{ lang.t(key) }}"> <meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
{% endfor %} {% endfor %}
<link rel="shortcut icon" href="{{ config.theme.favicon | url }}"> <link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-3.2.0"> <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-3.3.0">
{% endblock %} {% endblock %}
{% block htmltitle %} {% block htmltitle %}
{% if page and page.meta and page.meta.title %} {% if page and page.meta and page.meta.title %}

View File

@ -91,7 +91,10 @@ markdown_extensions:
emoji_generator: !!python/name:pymdownx.emoji.to_svg emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite - pymdownx.inlinehilite
- pymdownx.keys - pymdownx.keys
- pymdownx.magiclink - pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark - pymdownx.mark
- pymdownx.smartsymbols - pymdownx.smartsymbols
- pymdownx.superfences - pymdownx.superfences

View File

@ -1,6 +1,6 @@
{ {
"name": "mkdocs-material", "name": "mkdocs-material",
"version": "3.2.0", "version": "3.3.0",
"description": "A Material Design theme for MkDocs", "description": "A Material Design theme for MkDocs",
"keywords": [ "keywords": [
"mkdocs", "mkdocs",