release-notes.md

Release notes

Upgrading

To upgrade Material to the latest version, use pip:

pip install --upgrade mkdocs-material

To determine the currently installed version, use the following command:

pip show mkdocs-material | grep -E ^Version
# Version 1.10.3

Changelog

1.10.3 _ October 11, 2017

• Fixed #484: Fixed vertical scrollbar on some MathJax formulas
• Fixed #483: Fixed footnote backref target offset regression

1.10.2 _ October 6, 2017

• Fixed #468: Sidebar shows scrollbar if content is shorter (in Safari)

1.10.1 _ September 14, 2017

• Fixed #455: Bold code blocks rendered with normal font weight

1.10.0 _ September 1, 2017

• Added support to make logo default icon configurable
• Fixed uninitialized overflow scrolling on main pane for iOS
• Fixed error in mobile navigation in case JavaScript is not available
• 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

• Added info (synonym: todo) style for Admonition
• Added question (synonym: help, faq) style for Admonition
• Added support for Details from PyMdown Extensions package
• Improved Admonition styles to match Details
• Improved styles for social links in footer
• Replaced ligatures with Unicode code points to avoid broken layout
• Upgraded PyMdown Extensions package dependency to >= 3.4

1.8.1 _ August 7, 2017

• Fixed #421: Missing pagination for GitHub API

1.8.0 _ August 2, 2017

• 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

• 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

• Fixed functional link colors in table of contents for active palette
• Fixed #368: Compatibility issues with IE11

1.7.3 _ June 7, 2017

• Fixed error when setting language to Japanese for site search

1.7.2 _ June 6, 2017

• Fixed offset of search box when repo_url is not set
• Fixed non-disappearing tooltip

1.7.1 _ June 1, 2017

• Fixed wrong z-index order of header, overlay and drawer
• Fixed wrong offset of targeted footnote back references

1.7.0 _ June 1, 2017

• 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

• Fixed #337: JavaScript error for GitHub organization URLs

1.6.3 _ May 16, 2017

• Fixed #329: Broken source stats for private or unknown GitHub repos

1.6.2 _ May 15, 2017

• Fixed #316: Fatal error for git clone on Windows
• Fixed #320: Chrome 58 creates double underline for abbr tags
• Fixed #323: Ligatures rendered inside code blocks
• Fixed miscalculated sidebar height due to missing margin collapse
• Changed deprecated MathJax CDN to Cloudflare

1.6.1 _ April 23, 2017

• Fixed following of active/focused element if search input is focused
• Fixed layer order of search component elements

1.6.0 _ April 22, 2017

• Added build test for Docker image on Travis
• Added search overlay for better user experience (focus)
• Added language from localizations to html tag
• Fixed #270: source links broken for absolute URLs
• 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

• Fixed #282: Browser search (Meta+F) is hijacked

1.5.4 _ April 8, 2017

• 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

• Fixed deprecated calls for template variables
• Fixed wrong palette color for focused search result
• Fixed JavaScript errors on 404 page
• Fixed missing top spacing on 404 page
• Fixed missing right spacing on overflow of source container

1.5.2 _ April 5, 2017

• Added requirements as explicit dependencies in setup.py
• Fixed non-synchronized transitions in search form

1.5.1 _ March 30, 2017

• Fixed rendering and offset of targetted footnotes
• Fixed #238: Link on logo is not set to site_url

1.5.0 _ March 24, 2017

• Added support for localization of search placeholder
• Added keyboard events for quick access of search
• Added keyboard events for search control
• Added opacity on hover for search buttons
• Added git hook to skip CI build on non-src changes
• Fixed non-resetting search placeholder when input is cleared
• Fixed error for unescaped parentheses in search term
• Fixed #229: Button to clear search missing
• Fixed #231: Escape key doesn't exit search
• Removed old-style figures from font feature settings

1.4.1 _ March 16, 2017

• Fixed invalid destructuring attempt on NodeList (in Safari, Edge, IE)

1.4.0 _ March 16, 2017

• Added support for grouping searched sections by documents
• Added support for highlighting of search terms
• Added support for localization of search results
• 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