Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • greenkeeper/webpack-4.10.1
  • greenkeeper/webpack-4.10.0
  • greenkeeper/webpack-4.9.2
  • greenkeeper/promise-polyfill-8.0.0
  • greenkeeper/webpack-4.9.1
  • greenkeeper/webpack-4.9.0
  • greenkeeper/webpack-manifest-plugin-2.0.3
  • greenkeeper/update-to-node-10
  • gh-pages
  • greenkeeper/webpack-4.8.3
  • greenkeeper/webpack-4.8.2
  • greenkeeper/webpack-4.7.0
  • greenkeeper/webpack-manifest-plugin-2.0.2
  • greenkeeper/webpack-manifest-plugin-2.0.1
  • greenkeeper/style-loader-0.21.0
  • greenkeeper/webpack-4.6.0
  • greenkeeper/sass-loader-7.0.1
  • greenkeeper/sass-loader-7.0.0
  • greenkeeper/webpack-manifest-plugin-2.0.0
  • 2.7.3
  • 2.7.2
  • 2.7.1
  • 2.7.0
  • 2.6.6
  • 2.6.5
  • 2.6.4
  • 2.6.3
  • 2.6.2
  • 2.6.1
  • 2.6.0
  • 2.5.5
  • 2.5.4
  • 2.5.3
  • 2.5.2
  • 2.5.1
  • 2.5.0
  • 2.4.0
  • 2.3.0
  • 2.2.6
40 results

release-notes.md

Blame
    • release-notes.md 21.33 KiB

    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 2.3.0

    Material 1.x to 2.x

    • Material for MkDocs 2.x requires MkDocs 0.17.1, as this version introduced changes to the way themes can define options. The following variables inside your project's mkdocs.yml need to be renamed:

      • extra.feature becomes theme.feature
      • extra.palette becomes theme.palette
      • extra.font becomes theme.font
      • extra.logo becomes theme.logo

    • Favicon support has been dropped by MkDocs, it must now be defined in theme.favicon (previously site_favicon).

    • Localization is now separated into theme language and search language. While there can only be a single language on theme-level, the search supports multiple languages which can be separated by commas. See the getting started guide for more guidance.

    • The search tokenizer can now be set through extra.search.tokenizer.

    Changelog

    2.3.0 _ January 9, 2018

    • Added example (synonym: snippet) style for Admonition
    • Added synonym abstract for summary style for Admonition

    2.2.6 _ December 27, 2017

    • Added Turkish translations
    • Fixed unclickable area below header in case JavaScript is not available

    2.2.5 _ December 18, 2017

    • Fixed #639: Broken default favicon

    2.2.4 _ December 18, 2017

    • Fixed #638: Build breaks with Jinja < 2.9

    2.2.3 _ December 13, 2017

    • Fixed #630: Admonition sets padding on any last child
    • Adjusted Chinese (Traditional) translations

    2.2.2 _ December 8, 2017

    • Added Dutch translations
    • Adjusted targeted link and footnote offsets
    • Simplified Admonition styles and fixed padding bug

    2.2.1 _ December 2, 2017

    • Fixed #616: Minor styling error with title-only admonition blocks
    • Removed border for table of contents and improved spacing

    2.2.0 _ November 22, 2017

    • 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

    • 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

    • Added support for white as a primary color
    • Added support for sliding site name and title
    • Fixed redundant clipboard button when using line numbers on code blocks
    • Improved header appearance by making it taller
    • Improved tabs appearance
    • Improved CSS customizability by leveraging inheritance
    • Removed scroll shadows via background-attachment

    2.0.4 _ November 5, 2017

    • Fixed details not opening with footnote reference

    2.0.3 _ November 5, 2017

    • 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

    • Added Russian translations
    • Fixed #542: Horizontal scrollbar between 1220px and 1234px
    • Fixed #553: Metadata values only rendering first character
    • Fixed #558: Flash of unstyled content
    • Fixed favicon regression caused by deprecation upstream

    2.0.1 _ October 31, 2017

    • 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

    • Added support for MkDocs 0.17.1 theme configuration options
    • Added support for easier configuration of search tokenizer
    • Added support to disable search
    • Added Korean translations
    • Removed support for MkDocs 0.16.x

    1.12.2 _ October 26, 2017

    • Added Italian, Norwegian, French and Chinese translations

    1.12.1 _ October 22, 2017

    • 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

    • 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

    • Added localization to clipboard
    • Refactored localization logic

    1.10.4 _ October 18, 2017

    • 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

    • Fixed #484: Vertical scrollbar on some MathJax formulas
    • Fixed #483: 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