From c90b9211f41a529199309b2131995de8b66b9f38 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 15 Nov 2020 22:25:11 +0100 Subject: [PATCH] Updated documentation --- docs/changelog.md | 1064 ++++++++--------- docs/creating-your-site.md | 34 +- docs/getting-started.md | 4 +- docs/reference/code-blocks.md | 30 +- docs/reference/formatting.md | 20 +- docs/reference/icons-emojis.md | 30 +- docs/reference/lists.md | 16 +- docs/setup/adding-a-comment-system.md | 8 +- docs/setup/adding-a-git-repository.md | 20 +- docs/setup/changing-the-logo-and-icons.md | 6 +- docs/setup/setting-up-site-search.md | 12 +- docs/upgrading.md | 46 +- .../stylesheets/overrides/_typeset.scss | 5 + 13 files changed, 654 insertions(+), 641 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index b021a01b5..0dc7915ef 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -8,1065 +8,1065 @@ template: overrides/main.html ### 1.10.0 _ November 15, 2020 -* Added support for integrating table of contents into navigation +- Added support for integrating table of contents into navigation ### 1.9.0 _ November 7, 2020 -* Added support for hiding navigation and table of contents on any page -* Removed autohiding table of contents when empty +- 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 -* Added support for navigation sections -* Fixed appearance of inactive search suggestions +- Added support for navigation sections +- Fixed appearance of inactive search suggestions ### 1.7.0 _ October 25, 2020 -* Added support for deploying multiple versions -* Fixed alignment of sidebar when content area is too small +- Added support for deploying multiple versions +- Fixed alignment of sidebar when content area is too small ### 1.6.0 _ October 11, 2020 -* 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++ +- 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 -* Fixed content area stretching to whole width for long code blocks +- Fixed content area stretching to whole width for long code blocks ### 1.5.0 _ September 19, 2020 -* Added support for autohiding table of contents when empty +- Added support for autohiding table of contents when empty ### 1.4.1 _ September 6, 2020 -* Improved typeahead and search result relevance and scoring +- Improved typeahead and search result relevance and scoring ### 1.4.0 _ August 30, 2020 -* Added support for autohiding header on scroll +- Added support for autohiding header on scroll ### 1.3.0 _ August 26, 2020 -* Added support for user-selectable color palettes +- Added support for user-selectable color palettes ### 1.2.0 _ August 11, 2020 -* Added feature to expand navigation by default +- Added feature to expand navigation by default ### 1.1.0 _ August 3, 2020 -* Added highlighting of search results +- Added highlighting of search results ### 1.0.0 _ July 14, 2020 -* Added grouping of search results -* Added missing query terms to search result -* Improved search result relevance and scoring +- Added grouping of search results +- Added missing query terms to search result +- Improved search result relevance and scoring ## Material for MkDocs ### 6.1.5 _ November 15, 2020 -* Fixed search reset button not showing/hiding correctly +- Fixed search reset button not showing/hiding correctly ### 6.1.4 _ November 7, 2020 -* Fixed sidebar jitter when scrolling footer into view +- Fixed sidebar jitter when scrolling footer into view ### 6.1.3 _ November 5, 2020 -* 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 +- 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 -* Fixed sizing of icons in Admonition, Tasklist, etc. (6.1.1 regression) +- Fixed sizing of icons in Admonition, Tasklist, etc. (6.1.1 regression) ### 6.1.1 _ October 31, 2020 -* Fixed #2019: Page title not correctly updated when using instant loading +- Fixed #2019: Page title not correctly updated when using instant loading ### 6.1.0 _ October 17, 2020 -* Fixed #1973: Added support for printing in dark mode -* Fixed #1974: Added support for printing content tabs -* Fixed #1995: Improved customizability of details extension +- 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 -* 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 +- 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 -* Fixed stemmer support for `file://` protocol through `iframe-worker` -* Fixed details marker showing for search result in Firefox -* Fixed tabbing behavior when search query is not empty -* Switched TypeScript compilation target to ES2015 -* Reduced size of JavaScript by 30% (`176kb` → `124kb`) -* Removed `mkdocs` and `readthedocs` themes from Docker image +- Fixed stemmer support for `file://` protocol through `iframe-worker` +- Fixed details marker showing for search result in Firefox +- Fixed tabbing behavior when search query is not empty +- Switched TypeScript compilation target to ES2015 +- Reduced size of JavaScript by 30% (`176kb` → `124kb`) +- Removed `mkdocs` and `readthedocs` themes from Docker image ### 6.0.0 _ September 25, 2020 -* Improved search result look and feel -* Improved search result stability while typing -* Improved search result grouping (pages + headings) -* Improved search result relevance and scoring -* Added display of missing query terms to search results -* Reduced size of vendor bundle by 25% (`84kb` → `67kb`) -* Reduced size of the Docker image to improve CI build performance -* Removed hero partial in favor of custom implementation -* Removed deprecated front matter features +- Improved search result look and feel +- Improved search result stability while typing +- Improved search result grouping (pages + headings) +- Improved search result relevance and scoring +- Added display of missing query terms to search results +- Reduced size of vendor bundle by 25% (`84kb` → `67kb`) +- Reduced size of the Docker image to improve CI build performance +- Removed hero partial in favor of custom implementation +- Removed deprecated front matter features ### 5.5.14 _ September 23, 2020 -* Improved spacing around image captions -* Fixed #1939: Long tables cause header overlap in print view +- Improved spacing around image captions +- Fixed #1939: Long tables cause header overlap in print view ### 5.5.13 _ September 19, 2020 -* Improved abbreviations on touch devices +- Improved abbreviations on touch devices ### 5.5.12 _ August 31, 2020 -* Fixed #1638: occasional `404` for images when using instant loading +- Fixed #1638: occasional `404` for images when using instant loading ### 5.5.11 _ August 28, 2020 -* Fixed Disqus integration, as the minifier killed the config +- Fixed Disqus integration, as the minifier killed the config ### 5.5.10 _ August 28, 2020 -* Improved rendering by moving Disqus integration after page load -* Fixed #1887: Moved navigation icons to CSS to reduce size of HTML +- 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 -* Added Esperanto translations -* Fixed #1884: External links not included in navigation tabs +- Added Esperanto translations +- Fixed #1884: External links not included in navigation tabs ### 5.5.8 _ August 23, 2020 -* Removed focus outline on `details` and content tabs for pointer devices -* Improved accessibility of content tabs (now navigable via arrow keys) -* Fixed #1877: `404` on search index when search is disabled -* Fixed some memleaks in observable subscriptions -* Fixed color definitions for `theme-color` meta tag +- Removed focus outline on `details` and content tabs for pointer devices +- Improved accessibility of content tabs (now navigable via arrow keys) +- Fixed #1877: `404` on search index when search is disabled +- Fixed some memleaks in observable subscriptions +- Fixed color definitions for `theme-color` meta tag ### 5.5.7 _ August 16, 2020 -* Improved contrast ratio to 4.5:1 for syntax highlighting -* Improved contrast ratio to 4.5:1 for table of contents +- 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 -* Switched base template for `404.html` to `main.html` -* Fixed #1864: GitHub organisation stats not loading +- Switched base template for `404.html` to `main.html` +- Fixed #1864: GitHub organisation stats not loading ### 5.5.5 _ August 11, 2020 -* Fixed missing vendor and worker distribution files +- Fixed missing vendor and worker distribution files ### 5.5.4 _ August 11, 2020 -* Added support for sortable data tables +- Added support for sortable data tables ### 5.5.3 _ August 4, 2020 -* Fixed search for languages other than English (5.5.1 regression) +- Fixed search for languages other than English (5.5.1 regression) ### 5.5.2 _ August 3, 2020 -* Improved highlight colors and spacing for `ins`, `del` and `mark` -* Changed some keyboard symbols for better equivalents -* Removed focus `outline` for details and code blocks on touch devices -* Fixed margins for Admonitions (5.5.1 regression) -* Fixed too small content tab labels (5.5.1 regression) -* Fixed icon repeating for custom admonition icons +- Improved highlight colors and spacing for `ins`, `del` and `mark` +- Changed some keyboard symbols for better equivalents +- Removed focus `outline` for details and code blocks on touch devices +- Fixed margins for Admonitions (5.5.1 regression) +- Fixed too small content tab labels (5.5.1 regression) +- Fixed icon repeating for custom admonition icons ### 5.5.1 _ August 1, 2020 -* 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 +- 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 -* Rewrite of entire documentation -* Rewrite of syntax highlighting to be customizable with CSS variables -* Improved syntax highlighting to work with light and dark theme -* Improved `slate` color scheme to be more customizable and easier on the eyes -* Added licenses of icon sets to distribution files -* Fixed stale document titles in Google Analytics when using instant loading -* Fixed width of previous and next footer links for tablet and above -* Fixed issues with top scroll margin for footnotes -* Fixed top margin for tabbed content when using a JavaScript highlighter -* Deprecated metadata-based redirects, source links and heroes +- Rewrite of entire documentation +- Rewrite of syntax highlighting to be customizable with CSS variables +- Improved syntax highlighting to work with light and dark theme +- Improved `slate` color scheme to be more customizable and easier on the eyes +- Added licenses of icon sets to distribution files +- Fixed stale document titles in Google Analytics when using instant loading +- Fixed width of previous and next footer links for tablet and above +- Fixed issues with top scroll margin for footnotes +- 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 -* Added support to wrap searches in quotes to switch from `OR` to `AND` -* Fixed highlighting of numbers in search results +- 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 -* Added Bengali translations -* Fixed #1773: Search for numbers does not return any result (regression) +- Added Bengali translations +- Fixed #1773: Search for numbers does not return any result (regression) ### 5.3.2 _ June 21, 2020 -* Improved search typeahead experience with non-Latin characters -* Fixed #1753: Japanese search doesn't work anymore +- Improved search typeahead experience with non-Latin characters +- Fixed #1753: Japanese search doesn't work anymore ### 5.3.1 _ June 20, 2020 -* Fixed #1761: Duplication of search worker when subscribing to observable +- Fixed #1761: Duplication of search worker when subscribing to observable ### 5.3.0 _ June 15, 2020 -* Added support for color schemes based on user preference -* Fixed #1755: Tokenizer separator setting ignored +- Added support for color schemes based on user preference +- Fixed #1755: Tokenizer separator setting ignored ### 5.2.3 _ June 6, 2020 -* Improved search typeahead behavior for some languages (`de`, `fr`, ...) -* Improved styles for scrollbars on Firefox -* Fixed #1741: Removed `preconnect` hint for Google Analytics +- 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 -* Fixed #1728: Legacy Edge doesn't support `deg` values in `hsla` colors +- Fixed #1728: Legacy Edge doesn't support `deg` values in `hsla` colors ### 5.2.1 _ May 22, 2020 -* 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 +- 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 -* Added color schemes implementation + dark mode -* Fixed #1583: Missing option for separate link colors +- Added color schemes implementation + dark mode +- Fixed #1583: Missing option for separate link colors ### 5.1.7 _ May 16, 2020 -* Added keyboard focus support for overflowing code blocks -* Fixed #1696: Infinite loop in some cases when using instant loading +- 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 -* Added Burmese translations -* Added general anchor offset solution using `scroll-margin-top` -* Fixed #1653: Instant loading shouldn't intercept links to `*.html` files +- 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 -* 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+) +- 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 -* Switched to [@mdi/svg][3] Material Design icon package -* Fixed #1655: Navigation may disappear after switching viewports -* Fixed #1659: Unnecessary scrollbar for search results on Windows -* Fixed occasional distortions for images with explicit dimensions -* Fixed errors in German translations +- Switched to [@mdi/svg][3] Material Design icon package +- Fixed #1655: Navigation may disappear after switching viewports +- Fixed #1659: Unnecessary scrollbar for search results on Windows +- Fixed occasional distortions for images with explicit dimensions +- Fixed errors in German translations [3]: https://github.com/Templarian/MaterialDesign-SVG ### 5.1.3 _ April 26, 2020 -* Fixed overflowing content area after switch to flexbox +- Fixed overflowing content area after switch to flexbox ### 5.1.2 _ April 26, 2020 -* Added status information to search observable -* Added status information to search modal -* Removed announcement bar from print media -* Removed media query packing logic due to race conditions -* Fixed #1520: Gracefully disable search on `file://` if Worker fails -* Fixed re-submission of query after search is initialized -* Fixed jitter of sidebars on all browsers by switching to `sticky` +- Added status information to search observable +- Added status information to search modal +- Removed announcement bar from print media +- Removed media query packing logic due to race conditions +- Fixed #1520: Gracefully disable search on `file://` if Worker fails +- 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 -* Added new FontAwesome icons -* Fixed #1609: Instant loading doesn't honor `target=_blank` -* Fixed GitHub stars count rounding errors -* Fixed GitLab stars count retrieval +- 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 -* Added support for icons from Markdown through [mkdocs-material-extensions][2] +- Added support for icons from Markdown through [mkdocs-material-extensions][2] [2]: https://github.com/facelessuser/mkdocs-material-extensions ### 5.0.2 _ April 10, 2020 -* 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`) +- 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 -* Fixed syntax error in Spanish translation +- Fixed syntax error in Spanish translation ### 5.0.0 _ April 7, 2020 -* Reactive architecture – try `app.dialog$.next("Hi!")` in the console -* Instant loading – make Material behave like a Single Page Application -* Improved CSS customization with CSS variables – set your brand's colors -* Improved CSS resilience, e.g. proper sidebar locking for customized headers -* Improved icon integration and configuration – now including over 5k icons -* Added possibility to use any icon for logo, repository and social links -* Search UI does not freeze anymore (moved to web worker) -* Search index built only once when using instant loading -* Improved extensible keyboard handling -* Support for prebuilt search indexes -* Support for displaying stars and forks for GitLab repositories -* Support for scroll snapping of sidebars and search results -* Reduced HTML and CSS footprint due to deprecation of Internet Explorer support -* Slight facelifting of some UI elements (Admonitions, tables, ...) +- Reactive architecture – try `app.dialog$.next("Hi!")` in the console +- Instant loading – make Material behave like a Single Page Application +- Improved CSS customization with CSS variables – set your brand's colors +- Improved CSS resilience, e.g. proper sidebar locking for customized headers +- Improved icon integration and configuration – now including over 5k icons +- Added possibility to use any icon for logo, repository and social links +- Search UI does not freeze anymore (moved to web worker) +- Search index built only once when using instant loading +- Improved extensible keyboard handling +- Support for prebuilt search indexes +- Support for displaying stars and forks for GitLab repositories +- Support for scroll snapping of sidebars and search results +- 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 -* Removed optional third-party plugins from `requirements.txt` -* Updated Docker image to contain all supported third-party plugins +- Removed optional third-party plugins from `requirements.txt` +- Updated Docker image to contain all supported third-party plugins ### 4.6.2 _ February 8, 2020 -* Added Romanian translations -* Fixed #1451: Inconsistent spacing for fenced code blocks +- Added Romanian translations +- Fixed #1451: Inconsistent spacing for fenced code blocks ### 4.6.1 _ February 8, 2020 -* Fixed #1324: Metadata author only rendering first character -* Fixed #1393: Set `tabindex` to `0` for skip to content link -* Fixed code blocks after Markdown 3.2 release -* Fixed errors in Japanese translations -* Improved Google Lighthouse score +- Fixed #1324: Metadata author only rendering first character +- Fixed #1393: Set `tabindex` to `0` for skip to content link +- Fixed code blocks after Markdown 3.2 release +- Fixed errors in Japanese translations +- Improved Google Lighthouse score ### 4.6.0 _ December 11, 2019 -* Added support for [mkdocs-git-revision-date-localized-plugin][1] -* Fixed invalid character in Google Fonts URL +- Added support for [mkdocs-git-revision-date-localized-plugin][1] +- Fixed invalid character in Google Fonts URL [1]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin ### 4.5.1 _ December 2, 2019 -* Added Thai translations -* Fixed missing assets in GitHub release `.zip` and `.tar.gz` +- Added Thai translations +- Fixed missing assets in GitHub release `.zip` and `.tar.gz` ### 4.5.0 _ November 16, 2019 -* 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 +- 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 -* Added Estonian translations -* Fixed removal of copyright banners in minified JavaScript -* Removed unnecessary title attributes from links in table of contents +- 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 -* 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 +- 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 -* Added support for `black` as a primary color -* Fixed broken footer bar when `h1` contained HTML tags +- Added support for `black` as a primary color +- Fixed broken footer bar when `h1` contained HTML tags ### 4.4.0 _ June 15, 2019 -* 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` +- 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 -* Fixed spelling error in Danish translations +- Fixed spelling error in Danish translations ### 4.3.0 _ May 17, 2019 -* 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 +- 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 -* 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 +- 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 -* Fixed #1072: HTML tags appearing in navigation link titles +- Fixed #1072: HTML tags appearing in navigation link titles ### 4.1.1 _ March 28, 2019 -* Fixed minor CSS errors detected during validation +- Fixed minor CSS errors detected during validation ### 4.1.0 _ March 22, 2019 -* Fixed #1023: Search for Asian languages broken after Lunr.js update -* Fixed #1026: contenteditable elements loose focus on hotkeys +- 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 -* Fixed #1012: HTML character entities appear in search result titles +- Fixed #1012: HTML character entities appear in search result titles ### 4.0.1 _ February 13, 2019 -* Fixed #762, #816: Glitch in sidebar when collapsing items -* Fixed #869: Automatically expand details before printing +- Fixed #762, #816: Glitch in sidebar when collapsing items +- Fixed #869: Automatically expand details before printing ### 4.0.0 _ February 13, 2019 -* Added background on hover for table rows -* Removed Google Tag Manager and reverted to Google Analytics -* Removed blocks in partials - Jinja doesn't support them -* Fixed #911: Chrome breaks layout if system language is Chinese (**BREAKING**) -* Fixed #976: Removed FastClick +- Added background on hover for table rows +- Removed Google Tag Manager and reverted to Google Analytics +- Removed blocks in partials - Jinja doesn't support them +- Fixed #911: Chrome breaks layout if system language is Chinese (**BREAKING**) +- Fixed #976: Removed FastClick ### 3.3.0 _ January 29, 2019 -* 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 +- 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 -* Added support for redirects using metadata refresh -* Fixed #921: Load Google Analytics snippet asynchronously +- Added support for redirects using metadata refresh +- Fixed #921: Load Google Analytics snippet asynchronously ### 3.1.0 _ November 17, 2018 -* Added support for Progressive Web App Manifest -* Fixed #915: Search bug in Safari (upgraded Lunr.js) +- Added support for Progressive Web App Manifest +- Fixed #915: Search bug in Safari (upgraded Lunr.js) ### 3.0.6 _ October 26, 2018 -* Added Taiwanese translations -* Fixed #906: JavaScript code blocks evaluated in search results +- Added Taiwanese translations +- Fixed #906: JavaScript code blocks evaluated in search results ### 3.0.5 _ October 23, 2018 -* 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 +- 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 -* Updated Dutch translations -* Fixed #856: Removed preconnect meta tag if Google Fonts are disabled +- Updated Dutch translations +- Fixed #856: Removed preconnect meta tag if Google Fonts are disabled ### 3.0.3 _ August 7, 2018 -* Fixed #841: Additional path levels for extra CSS and JS +- Fixed #841: Additional path levels for extra CSS and JS ### 3.0.2 _ August 6, 2018 -* Fixed #839: Lunr.js stemmer imports incorrect +- Fixed #839: Lunr.js stemmer imports incorrect ### 3.0.1 _ August 5, 2018 -* Fixed #838: Search result links incorrect +- Fixed #838: Search result links incorrect ### 3.0.0 _ August 5, 2018 -* Upgraded MkDocs to 1.0 (**BREAKING**) -* Upgraded Python in official Docker image to 3.6 -* Added Serbian and Serbo-Croatian translations +- 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 -* Fixed build error after MkDocs upgrade +- Fixed build error after MkDocs upgrade ### 2.9.3 _ July 29, 2018 -* Added link to home for logo in drawer -* Fixed dependency problems between MkDocs and Tornado +- Added link to home for logo in drawer +- Fixed dependency problems between MkDocs and Tornado ### 2.9.2 _ June 29, 2018 -* Added Hindi and Czech translations +- Added Hindi and Czech translations ### 2.9.1 _ June 18, 2018 -* 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` +- 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 -* Added support for theme color on Android -* Fixed #796: Rendering of nested tabbed code blocks +- Added support for theme color on Android +- Fixed #796: Rendering of nested tabbed code blocks ### 2.8.0 _ June 10, 2018 -* Added support for grouping code blocks with tabs -* Added Material and FontAwesome icon fonts to distribution files (GDPR) -* Added note on compliance with GDPR -* Added Slovak translations -* Fixed #790: Prefixed `id` attributes with `__` to avoid name clashes +- Added support for grouping code blocks with tabs +- Added Material and FontAwesome icon fonts to distribution files (GDPR) +- Added note on compliance with GDPR +- Added Slovak translations +- Fixed #790: Prefixed `id` attributes with `__` to avoid name clashes ### 2.7.3 _ April 26, 2018 -* Added Finnish translations +- Added Finnish translations ### 2.7.2 _ April 9, 2018 -* Fixed rendering issue for `details` on Edge +- Fixed rendering issue for `details` on Edge ### 2.7.1 _ March 21, 2018 -* 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 +- 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 -* Added ability to set absolute URL for logo -* Added Hebrew translations +- Added ability to set absolute URL for logo +- Added Hebrew translations ### 2.6.6 _ February 22, 2018 -* Added preconnect for Google Fonts for faster loading -* Fixed #710: With tabs sidebar disappears if JavaScript is not available +- 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 -* Reverted `--dev-addr` flag removal from `Dockerfile` +- Reverted `--dev-addr` flag removal from `Dockerfile` ### 2.6.4 _ February 21, 2018 -* Added Catalan translations -* Fixed incorrect margins for buttons in Firefox and Safari -* Replaced package manager `yarn` with `npm 5.6` -* Reverted GitHub stars rounding method -* Removed `--dev-addr` flag from `Dockerfile` for Windows compatibility +- Added Catalan translations +- Fixed incorrect margins for buttons in Firefox and Safari +- Replaced package manager `yarn` with `npm 5.6` +- Reverted GitHub stars rounding method +- Removed `--dev-addr` flag from `Dockerfile` for Windows compatibility ### 2.6.3 _ February 18, 2018 -* Added Vietnamese translations +- Added Vietnamese translations ### 2.6.2 _ February 12, 2018 -* Added Arabic translations -* Fixed incorrect rounding of amount of GitHub stars -* Fixed double-layered borders for tables +- Added Arabic translations +- Fixed incorrect rounding of amount of GitHub stars +- Fixed double-layered borders for tables ### 2.6.1 _ February 11, 2018 -* 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 +- 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 -* Moved default search configuration to default translation (English) -* Added support to automatically set text direction from translation -* Added support to disable search stop word filter in translation -* Added support to disable search trimmer in translation -* Added Persian translations -* Fixed support for Polish search -* Fixed disappearing GitHub, GitLab and Bitbucket repository icons +- Moved default search configuration to default translation (English) +- Added support to automatically set text direction from translation +- Added support to disable search stop word filter in translation +- Added support to disable search trimmer in translation +- Added Persian translations +- Fixed support for Polish search +- Fixed disappearing GitHub, GitLab and Bitbucket repository icons ### 2.5.5 _ January 31, 2018 -* Added Hungarian translations +- Added Hungarian translations ### 2.5.4 _ January 29, 2018 -* Fixed #683: `gh-deploy` fails inside Docker +- Fixed #683: `gh-deploy` fails inside Docker ### 2.5.3 _ January 25, 2018 -* Added Ukrainian translations +- Added Ukrainian translations ### 2.5.2 _ January 22, 2018 -* 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 +- 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 -* Fixed permalink for main headline -* Improved missing translation handling with English as a fallback -* Improved accessibility with skip-to-content link +- 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 -* Added support for right-to-left languages +- Added support for right-to-left languages ### 2.4.0 _ January 11, 2018 -* Added focus state for clipboard buttons -* Fixed #400: Search bar steals tab focus -* Fixed search not closing on ++enter++ when result is selected -* Fixed search not closing when losing focus due to ++tab++ -* Fixed collapsed navigation links getting focus -* Fixed `outline` being cut off on ++tab++ focus of navigation links -* Fixed bug with first search result navigation being ignored -* Removed search result navigation via ++tab++ (use ++up++ and ++down++) -* Removed `outline` resets for links -* Improved general tabbing behavior on desktop +- Added focus state for clipboard buttons +- Fixed #400: Search bar steals tab focus +- Fixed search not closing on ++enter++ when result is selected +- Fixed search not closing when losing focus due to ++tab++ +- Fixed collapsed navigation links getting focus +- Fixed `outline` being cut off on ++tab++ focus of navigation links +- Fixed bug with first search result navigation being ignored +- Removed search result navigation via ++tab++ (use ++up++ and ++down++) +- Removed `outline` resets for links +- Improved general tabbing behavior on desktop ### 2.3.0 _ January 9, 2018 -* Added `example` (synonym: `snippet`) style for Admonition -* Added synonym `abstract` for `summary` style for Admonition +- 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 +- 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 +- Fixed #639: Broken default favicon ### 2.2.4 _ December 18, 2017 -* Fixed #638: Build breaks with Jinja < 2.9 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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` +- 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 +- 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 +- 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 +- 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 +- 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 -* Upgraded MkDocs to 0.17.1 (__BREAKING__) -* Added support for easier configuration of search tokenizer -* Added support to disable search -* Added Korean translations +- 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 -* Added Italian, Norwegian, French and Chinese translations +- 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 +- 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 +- 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 +- 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 +- 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 +- 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) +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 +- 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 targeted footnotes -* Fixed #238: Link on logo is not set to `site_url` +- Fixed rendering and offset of targeted 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 +- 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) +- 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 +- 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 -* Added support for page-specific title and description using metadata -* Added support for linking source files to documentation -* Fixed jitter and offset of sidebar when zooming browser -* Fixed incorrectly initialized tablet sidebar height -* 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 issue with whitespace in path for scripts -* Fixed #205: support non-fixed (static) header -* Refactored footnote references for better visibility -* Reduced repaints to a minimum for non-tabs configuration -* Reduced contrast of edit button (slightly) +- Added support for page-specific title and description using metadata +- Added support for linking source files to documentation +- Fixed jitter and offset of sidebar when zooming browser +- Fixed incorrectly initialized tablet sidebar height +- 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 issue with whitespace in path for scripts +- Fixed #205: support non-fixed (static) header +- Refactored footnote references for better visibility +- Reduced repaints to a minimum for non-tabs configuration +- Reduced contrast of edit button (slightly) ### 1.2.0 _ March 3, 2017 -* Added `quote` (synonym: `cite`) style for Admonition -* Added help message to build pipeline -* Fixed wrong navigation link colors when applying palette -* Fixed #197: Link missing in tabs navigation on deeply nested items -* Removed unnecessary dev dependencies +- Added `quote` (synonym: `cite`) style for Admonition +- Added help message to build pipeline +- Fixed wrong navigation link colors when applying palette +- Fixed #197: Link missing in tabs navigation on deeply nested items +- Removed unnecessary dev dependencies ### 1.1.1 _ February 26, 2017 -* Fixed incorrectly displayed nested lists when using tabs +- Fixed incorrectly displayed nested lists when using tabs ### 1.1.0 _ February 26, 2017 -* Added tabs navigation feature (optional) -* Added Disqus integration (optional) -* Added a high resolution Favicon with the new logo -* Added static type checking using Facebook's Flow -* Fixed #173: Dictionary elements have no bottom spacing -* Fixed #175: Tables cannot be set to 100% width -* Fixed race conditions in build related to asset revisioning -* Fixed accidentally re-introduced Permalink on top-level headline -* Fixed alignment of logo in drawer on IE11 -* Refactored styles related to tables -* Refactored and automated Docker build and PyPI release -* Refactored build scripts +- Added tabs navigation feature (optional) +- Added Disqus integration (optional) +- Added a high resolution Favicon with the new logo +- Added static type checking using Facebook's Flow +- Fixed #173: Dictionary elements have no bottom spacing +- Fixed #175: Tables cannot be set to 100% width +- Fixed race conditions in build related to asset revisioning +- Fixed accidentally re-introduced Permalink on top-level headline +- Fixed alignment of logo in drawer on IE11 +- Refactored styles related to tables +- Refactored and automated Docker build and PyPI release +- Refactored build scripts ### 1.0.5 _ February 18, 2017 -* Fixed #153: Sidebar flows out of constrained area in Chrome 56 -* Fixed #159: Footer jitter due to JavaScript if content is short +- 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 -* 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` +- 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 -* Fixed #117: Table of contents items don't blur on fast scrolling -* Refactored sidebar positioning logic -* Further reduction of repaints +- 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 -* Fixed #108: Horizontal scrollbar in content area +- Fixed #108: Horizontal scrollbar in content area ### 1.0.1 _ January 14, 2017 -* 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 +- 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 -* Introduced Webpack for more sophisticated JavaScript bundling -* Introduced ESLint and Stylelint for code style checks -* Introduced more accurate Material Design colors and shadows -* Introduced modular scales for harmonic font sizing -* Introduced git-hooks for better development workflow -* Rewrite of CSS using the BEM methodology and SassDoc guidelines -* Rewrite of JavaScript using ES6 and Babel as a transpiler -* Rewrite of Admonition, Permalinks and CodeHilite integration -* Rewrite of the complete typographical system -* Rewrite of Gulp asset pipeline in ES6 and separation of tasks -* Removed Bower as a dependency in favor of NPM -* Removed custom icon build in favor of the Material Design icon set -* Removed `_blank` targets on links due to vulnerability: http://bit.ly/1Mk2Rtw -* Removed unversioned assets from build directory -* Restructured templates into base templates and partials -* Added build and watch scripts in `package.json` -* Added support for Metadata and Footnotes Markdown extensions -* Added support for PyMdown Extensions package -* Added support for collapsible sections in navigation -* Added support for separate table of contents -* Added support for better accessibility through REM-based layout -* Added icons for GitHub, GitLab and BitBucket integrations -* Added more detailed documentation on specimen, extensions etc. -* Added a `404.html` error page for deployment on GitHub Pages -* Fixed live reload chain in watch mode when saving a template -* Fixed variable references to work with MkDocs 0.16 +- Introduced Webpack for more sophisticated JavaScript bundling +- Introduced ESLint and Stylelint for code style checks +- Introduced more accurate Material Design colors and shadows +- Introduced modular scales for harmonic font sizing +- Introduced git-hooks for better development workflow +- Rewrite of CSS using the BEM methodology and SassDoc guidelines +- Rewrite of JavaScript using ES6 and Babel as a transpiler +- Rewrite of Admonition, Permalinks and CodeHilite integration +- Rewrite of the complete typographical system +- Rewrite of Gulp asset pipeline in ES6 and separation of tasks +- Removed Bower as a dependency in favor of NPM +- Removed custom icon build in favor of the Material Design icon set +- Removed `_blank` targets on links due to vulnerability: http://bit.ly/1Mk2Rtw +- Removed unversioned assets from build directory +- Restructured templates into base templates and partials +- Added build and watch scripts in `package.json` +- Added support for Metadata and Footnotes Markdown extensions +- Added support for PyMdown Extensions package +- Added support for collapsible sections in navigation +- Added support for separate table of contents +- Added support for better accessibility through REM-based layout +- Added icons for GitHub, GitLab and BitBucket integrations +- Added more detailed documentation on specimen, extensions etc. +- Added a `404.html` error page for deployment on GitHub Pages +- 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 -* 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 +- 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 -* Fixed #25: Highlight inline fenced blocks -* Fixed #26: Better highlighting for keystrokes -* Fixed #30: Suboptimal syntax highlighting for PHP +- 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 -* 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 +- 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 -* Fixed #10: Invisible header after closing search bar with ESC key -* Fixed #13: Table cells don't wrap -* Fixed empty list in table of contents when no headline is defined -* Corrected wrong path for static asset monitoring in Gulpfile.js -* Set up tracking of site search for Google Analytics +- Fixed #10: Invisible header after closing search bar with ESC key +- Fixed #13: Table cells don't wrap +- Fixed empty list in table of contents when no headline is defined +- 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 -* 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) +- 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 -* 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 +- 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 -* Fixed styles for deep navigational hierarchies -* Fixed webfont delivery problem when hosted in subdirectories -* Fixed print styles in mobile/tablet configuration -* Added option to configure fonts in `mkdocs.yml` with fallbacks -* Changed styles for admonition notes and warnings -* Set download link to latest version if available -* Set up tracking of outgoing links and actions for Google Analytics +- Fixed styles for deep navigational hierarchies +- Fixed webfont delivery problem when hosted in subdirectories +- Fixed print styles in mobile/tablet configuration +- Added option to configure fonts in `mkdocs.yml` with fallbacks +- Changed styles for admonition notes and warnings +- 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 -* Fixed #1: GitHub stars don't work if the repo_url ends with a `/` -* Updated NPM and Bower dependencies to most recent versions -* Changed footer/copyright link to Material theme to GitHub pages -* Made MkDocs building/serving in build process optional -* Set up continuous integration with Travis +- Fixed #1: GitHub stars don't work if the repo_url ends with a `/` +- Updated NPM and Bower dependencies to most recent versions +- Changed footer/copyright link to Material theme to GitHub pages +- Made MkDocs building/serving in build process optional +- Set up continuous integration with Travis ### 0.1.0 _ February 9, 2016 -* Initial release +- Initial release diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 749ca88f4..19ec934fe 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -77,9 +77,9 @@ be slightly different: logo: logo ``` -_If you cloned Material for MkDocs from GitHub, you must add all of the themes' -defaults by yourself, since_ [`mkdocs_theme.yml`][3] _is not loaded (as -[described in the official documentation][4])._ +_If you cloned Material for MkDocs from GitHub, you must list all of the themes' +defaults, because_ [`mkdocs_theme.yml`][3] _is not loaded automatically as +[described in the official documentation][4]._ [2]: getting-started.md#installation [3]: https://github.com/squidfunk/mkdocs-material/blob/master/src/mkdocs_theme.yml @@ -91,18 +91,22 @@ Material for MkDocs comes with a lot of configuration options. The _setup_ section explains in great detail how to configure and customize colors, fonts, icons and much more: -* [Changing the colors][5] -* [Changing the fonts][6] -* [Changing the language][7] -* [Changing the logo and icons][8] -* [Setting up navigation][9] -* [Setting up site search][10] -* [Setting up site analytics][11] -* [Setting up versioning][12] -* [Setting up the header][13] -* [Setting up the footer][14] -* [Adding a git repository][15] -* [Adding a comment system][16] + [5]: setup/changing-the-colors.md [6]: setup/changing-the-fonts.md diff --git a/docs/getting-started.md b/docs/getting-started.md index 602b28f43..2b4a566c6 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -67,8 +67,8 @@ covered in the following sections. The following plugins are bundled with the Docker image: -* [mkdocs-minify-plugin][12] -* [mkdocs-redirects][13] +- [mkdocs-minify-plugin][12] +- [mkdocs-redirects][13] [11]: https://hub.docker.com/r/squidfunk/mkdocs-material/ [12]: https://github.com/byrnereese/mkdocs-minify-plugin diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index 0436e6096..ae086c009 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -339,24 +339,24 @@ If [Pygments][23] is used, Material for MkDocs provides the [styles for code blocks][22], which are built with a custom and well-balanced palette that works equally well for both [color schemes][24]: -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-number-color) " } `--md-code-hl-number-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-special-color) " } `--md-code-hl-special-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-function-color) " } `--md-code-hl-function-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-constant-color) " } `--md-code-hl-constant-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-keyword-color) " } `--md-code-hl-keyword-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-string-color) " } `--md-code-hl-string-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-name-color) " } `--md-code-hl-name-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-operator-color) " } `--md-code-hl-operator-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-punctuation-color) " } `--md-code-hl-punctuation-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-comment-color) " } `--md-code-hl-comment-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-generic-color) " } `--md-code-hl-generic-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-variable-color) " } `--md-code-hl-variable-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-number-color) " } `--md-code-hl-number-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-special-color) " } `--md-code-hl-special-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-function-color) " } `--md-code-hl-function-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-constant-color) " } `--md-code-hl-constant-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-keyword-color) " } `--md-code-hl-keyword-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-string-color) " } `--md-code-hl-string-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-name-color) " } `--md-code-hl-name-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-operator-color) " } `--md-code-hl-operator-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-punctuation-color) " } `--md-code-hl-punctuation-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-comment-color) " } `--md-code-hl-comment-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-generic-color) " } `--md-code-hl-generic-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-variable-color) " } `--md-code-hl-variable-color` Code block foreground, background and line highlight colors are defined via: -* :material-checkbox-blank-circle:{: style="color: var(--md-code-fg-color) " } `--md-code-fg-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-bg-color) " } `--md-code-bg-color` -* :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-color) " } `--md-code-hl-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-fg-color) " } `--md-code-fg-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-bg-color) " } `--md-code-bg-color` +- :material-checkbox-blank-circle:{: style="color: var(--md-code-hl-color) " } `--md-code-hl-color` Let's say you want to change the color of `#!js "strings"`. While there are several [types of string tokens][25], Material for MkDocs assigns a single color diff --git a/docs/reference/formatting.md b/docs/reference/formatting.md index c87aef939..9a94be3a4 100644 --- a/docs/reference/formatting.md +++ b/docs/reference/formatting.md @@ -155,16 +155,16 @@ highlighted with a nicer syntax than using the corresponding `mark`, `ins` and _Example_: ``` markdown -* ==This was marked== -* ^^This was inserted^^ -* ~~This was deleted~~ +- ==This was marked== +- ^^This was inserted^^ +- ~~This was deleted~~ ``` _Result_: -* ==This was marked== -* ^^This was inserted^^ -* ~~This was deleted~~ +- ==This was marked== +- ^^This was inserted^^ +- ~~This was deleted~~ [11]: #caret-mark-tilde @@ -177,13 +177,13 @@ HTML tags: _Example_: ``` markdown -* H~2~0 -* A^T^A +- H~2~0 +- A^T^A ``` _Result_: -* H~2~0 -* A^T^A +- H~2~0 +- A^T^A [11]: #caret-mark-tilde diff --git a/docs/reference/icons-emojis.md b/docs/reference/icons-emojis.md index e7c225458..b92fe4e03 100644 --- a/docs/reference/icons-emojis.md +++ b/docs/reference/icons-emojis.md @@ -28,9 +28,9 @@ markdown_extensions: The following icon sets are bundled with Material for MkDocs: -* :material-material-design: – [Material Design][6] -* :fontawesome-brands-font-awesome-flag: – [FontAwesome][7] -* :octicons-mark-github-16: – [Octicons][8] +- :material-material-design: – [Material Design][6] +- :fontawesome-brands-font-awesome-flag: – [FontAwesome][7] +- :octicons-mark-github-16: – [Octicons][8] You can also add [additional icons][9]. When using emojis, it's recommended to consult the official documentation of [Python Markdown Extensions][3] to learn @@ -89,16 +89,16 @@ a valid path to any icon bundled with the theme, which are located in the _Example_: ``` -* :material-account-circle: – `.icons/material/account-circle.svg` -* :fontawesome-regular-laugh-wink: – `.icons/fontawesome/regular/laugh-wink.svg` -* :octicons-octoface-16: – `.icons/octicons/octoface-16.svg` +- :material-account-circle: – `.icons/material/account-circle.svg` +- :fontawesome-regular-laugh-wink: – `.icons/fontawesome/regular/laugh-wink.svg` +- :octicons-octoface-16: – `.icons/octicons/octoface-16.svg` ``` _Result_: -* :material-account-circle: – [`.icons/material/account-circle.svg`][14] -* :fontawesome-regular-laugh-wink: – [`.icons/fontawesome/regular/laugh-wink.svg`][15] -* :octicons-octoface-16: – [`.icons/octicons/octoface-16.svg`][16] +- :material-account-circle: – [`.icons/material/account-circle.svg`][14] +- :fontawesome-regular-laugh-wink: – [`.icons/fontawesome/regular/laugh-wink.svg`][15] +- :octicons-octoface-16: – [`.icons/octicons/octoface-16.svg`][16] [13]: #emoji [14]: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/material/.icons/material/account-circle.svg @@ -141,16 +141,16 @@ Then, simply add the CSS class to the icon. _Example_: ``` markdown -* :fontawesome-brands-medium:{: .medium } – Medium -* :fontawesome-brands-twitter:{: .twitter } – Twitter -* :fontawesome-brands-facebook:{: .facebook } – Facebook +- :fontawesome-brands-medium:{: .medium } – Medium +- :fontawesome-brands-twitter:{: .twitter } – Twitter +- :fontawesome-brands-facebook:{: .facebook } – Facebook ``` _Result_: -* :fontawesome-brands-medium:{: .medium } – Medium -* :fontawesome-brands-twitter:{: .twitter } – Twitter -* :fontawesome-brands-facebook:{: .facebook } – Facebook +- :fontawesome-brands-medium:{: .medium } – Medium +- :fontawesome-brands-twitter:{: .twitter } – Twitter +- :fontawesome-brands-facebook:{: .facebook } – Facebook [17]: #attribute-list [18]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/style diff --git a/docs/reference/lists.md b/docs/reference/lists.md index 425599b9a..7afd1b6ba 100644 --- a/docs/reference/lists.md +++ b/docs/reference/lists.md @@ -74,7 +74,7 @@ of lists can be nested inside each other. _Example_: ``` markdown -* Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur +- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam. @@ -85,7 +85,7 @@ _Example_: _Result_: -* Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur +- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam. @@ -182,21 +182,21 @@ checkbox. _Example_: ``` markdown -* [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit -* [ ] Vestibulum convallis sit amet nisi a tincidunt +- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit +- [ ] Vestibulum convallis sit amet nisi a tincidunt * [x] In hac habitasse platea dictumst * [x] In scelerisque nibh non dolor mollis congue sed et metus * [ ] Praesent sed risus massa -* [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque +- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque ``` _Result_: -* [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit -* [ ] Vestibulum convallis sit amet nisi a tincidunt +- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit +- [ ] Vestibulum convallis sit amet nisi a tincidunt * [x] In hac habitasse platea dictumst * [x] In scelerisque nibh non dolor mollis congue sed et metus * [ ] Praesent sed risus massa -* [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque +- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque [7]: #tasklist diff --git a/docs/setup/adding-a-comment-system.md b/docs/setup/adding-a-comment-system.md index bdc2057a7..4fe264459 100644 --- a/docs/setup/adding-a-comment-system.md +++ b/docs/setup/adding-a-comment-system.md @@ -62,18 +62,22 @@ specific pages by adding the following to the front matter of a page: === "Enable Disqus" - ``` markdown + ``` yaml --- disqus: --- + + ... ``` === "Disable Disqus" - ``` markdown + ``` yaml --- disqus: "" --- + + ... ``` [7]: #metadata diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 0dca2db4c..e7ab67a40 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -59,16 +59,16 @@ theme: Some popular choices: -* :fontawesome-brands-git: – `fontawesome/brands/git` -* :fontawesome-brands-git-alt: – `fontawesome/brands/git-alt` -* :fontawesome-brands-git-square: – `fontawesome/brands/git-square` -* :fontawesome-brands-github: – `fontawesome/brands/github` -* :fontawesome-brands-github-alt: – `fontawesome/brands/github-alt` -* :fontawesome-brands-github-square: – `fontawesome/brands/github-square` -* :fontawesome-brands-gitlab: – `fontawesome/brands/gitlab` -* :fontawesome-brands-gitkraken: – `fontawesome/brands/gitkraken` -* :fontawesome-brands-bitbucket: – `fontawesome/brands/bitbucket` -* :fontawesome-solid-trash: – `fontawesome/solid/trash` +- :fontawesome-brands-git: – `fontawesome/brands/git` +- :fontawesome-brands-git-alt: – `fontawesome/brands/git-alt` +- :fontawesome-brands-git-square: – `fontawesome/brands/git-square` +- :fontawesome-brands-github: – `fontawesome/brands/github` +- :fontawesome-brands-github-alt: – `fontawesome/brands/github-alt` +- :fontawesome-brands-github-square: – `fontawesome/brands/github-square` +- :fontawesome-brands-gitlab: – `fontawesome/brands/gitlab` +- :fontawesome-brands-gitkraken: – `fontawesome/brands/gitkraken` +- :fontawesome-brands-bitbucket: – `fontawesome/brands/bitbucket` +- :fontawesome-solid-trash: – `fontawesome/solid/trash` [4]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index bbf0a9426..3666f7ab8 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -72,9 +72,9 @@ markdown_extensions: The following icon sets are bundled with Material for MkDocs: -* :material-material-design: – [Material Design][8] -* :fontawesome-brands-font-awesome-flag: – [FontAwesome][9] -* :octicons-mark-github-16: – [Octicons][10] +- :material-material-design: – [Material Design][8] +- :fontawesome-brands-font-awesome-flag: – [FontAwesome][9] +- :octicons-mark-github-16: – [Octicons][10] If you want to add [additional icons][1], read on. diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index 7d2872486..12106a7b7 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -312,15 +312,15 @@ message format using _discriminated unions_, i.e. through the `type` property of the message. See the following interface definitions to learn about the message formats: -* [:octicons-file-code-24: `SearchMessage`][22] -* [:octicons-file-code-24: `SearchIndex` and `SearchResult`][23] +- [:octicons-file-code-24: `SearchMessage`][22] +- [:octicons-file-code-24: `SearchIndex` and `SearchResult`][23] The sequence and direction of messages is rather intuitive: -* :octicons-arrow-right-24: `SearchSetupMessage` -* :octicons-arrow-left-24: `SearchReadyMessage` -* :octicons-arrow-right-24: `SearchQueryMessage` -* :octicons-arrow-left-24: `SearchResultMessage` +- :octicons-arrow-right-24: `SearchSetupMessage` +- :octicons-arrow-left-24: `SearchReadyMessage` +- :octicons-arrow-right-24: `SearchQueryMessage` +- :octicons-arrow-left-24: `SearchResultMessage` [20]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/search/worker [21]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers diff --git a/docs/upgrading.md b/docs/upgrading.md index 319e235a0..51e971cde 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -20,15 +20,15 @@ pip show mkdocs-material ### What's new? -* Improved search result look and feel -* Improved search result stability while typing -* Improved search result grouping (pages + headings) -* Improved search result relevance and scoring -* Added display of missing query terms to search results -* Reduced size of vendor bundle by 25% (84kb → 67kb) -* Reduced size of the Docker image to improve CI build performance -* Removed hero partial in favor of [custom implementation][1] -* Removed [deprecated front matter features][2] +- Improved search result look and feel +- Improved search result stability while typing +- Improved search result grouping (pages + headings) +- Improved search result relevance and scoring +- Added display of missing query terms to search results +- Reduced size of vendor bundle by 25% (84kb → 67kb) +- Reduced size of the Docker image to improve CI build performance +- Removed hero partial in favor of [custom implementation][1] +- Removed [deprecated front matter features][2] [1]: deprecations.md#hero [2]: deprecations.md#front-matter @@ -287,20 +287,20 @@ matches the new structure: ### What's new? -* Reactive architecture – try `#!js app.dialog$.next("Hi!")` in the console -* [Instant loading][4] – make Material behave like a Single Page Application -* Improved CSS customization with [CSS variables][5] – set your brand's colors -* Improved CSS resilience, e.g. proper sidebar locking for customized headers -* Improved [icon integration][6] and configuration – now including over 5k icons -* Added possibility to use any icon for logo, repository and social links -* Search UI does not freeze anymore (moved to web worker) -* Search index built only once when using instant loading -* Improved extensible keyboard handling -* Support for [prebuilt search indexes][7] -* Support for displaying stars and forks for GitLab repositories -* Support for scroll snapping of sidebars and search results -* Reduced HTML and CSS footprint due to deprecation of Internet Explorer support -* Slight facelifting of some UI elements (Admonitions, tables, ...) +- Reactive architecture – try `#!js app.dialog$.next("Hi!")` in the console +- [Instant loading][4] – make Material behave like a Single Page Application +- Improved CSS customization with [CSS variables][5] – set your brand's colors +- Improved CSS resilience, e.g. proper sidebar locking for customized headers +- Improved [icon integration][6] and configuration – now including over 5k icons +- Added possibility to use any icon for logo, repository and social links +- Search UI does not freeze anymore (moved to web worker) +- Search index built only once when using instant loading +- Improved extensible keyboard handling +- Support for [prebuilt search indexes][7] +- Support for displaying stars and forks for GitLab repositories +- Support for scroll snapping of sidebars and search results +- Reduced HTML and CSS footprint due to deprecation of Internet Explorer support +- Slight facelifting of some UI elements (Admonitions, tables, ...) [5]: setup/changing-the-colors.md#custom-colors [6]: setup/changing-the-logo-and-icons.md#icons diff --git a/src/assets/stylesheets/overrides/_typeset.scss b/src/assets/stylesheets/overrides/_typeset.scss index f66f4583f..bf0d6dd4d 100644 --- a/src/assets/stylesheets/overrides/_typeset.scss +++ b/src/assets/stylesheets/overrides/_typeset.scss @@ -58,5 +58,10 @@ > * { break-inside: avoid; } + + // [mobile portrait -]: Reset columns on mobile + @include break-to-device(mobile portrait) { + columns: initial; + } } }