diff --git a/CHANGELOG b/CHANGELOG index 74181b2bd..06b2be77c 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,10 @@ +mkdocs-material-7.1.0 (2021-03-29) + + * Added support for color palette toggle + * Added support for back-to-top button + * Added latest release to repository info (GitHub) + * Slight facelift of repository info (lighter fonts, spacing and icons) + mkdocs-material-7.0.7+insiders-2.5.0 (2021-03-28) * Added support for version warning diff --git a/docs/assets/screenshots/repository.png b/docs/assets/screenshots/repository.png deleted file mode 100644 index 992f1d80e..000000000 Binary files a/docs/assets/screenshots/repository.png and /dev/null differ diff --git a/docs/changelog.md b/docs/changelog.md index ca6a6844f..c405d2544 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -6,6 +6,13 @@ template: overrides/main.html ## Material for MkDocs +### 7.1.0 _ March 29, 2021 + +- Added support for back-to-top button +- Added support for color palette toggle +- Added latest release to repository info (GitHub) +- Slight facelift of repository info (lighter fonts, spacing and icons) + ### 7.0.7 _ March 28, 2021 - Updated Hungarian translations diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 6a45879fa..7a3c9e3ae 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -114,11 +114,8 @@ The following features are currently exclusively available to sponsors: - [x] [Version warning :material-new-box:][26] - [x] [Custom admonition icons :material-new-box:][28] - [x] [Code block annotations :material-new-box:][25] -- [x] [Back-to-top button][17] - [x] [Anchor tracking ][24] - [x] [Section index pages][22] -- [x] [Latest release tag][15] -- [x] [Color palette toggle][16] - [x] [Sticky navigation tabs][21] - [x] [Mermaid.js integration][27] - [x] [Search suggestions][18] @@ -142,18 +139,6 @@ Following is a list of funding goals. When a funding goal is hit, the features that are tied to it are merged back into Material for MkDocs and released to the public for general availability. -#### $ 2,000 – Black Pearl - -_Goal reached :tada: – features will be merged in the next days!_ - -- [x] [Latest release tag][15] -- [x] [Color palette toggle][16] -- [x] [Back-to-top button][17] - - [15]: ../setup/adding-a-git-repository.md#latest-release - [16]: ../setup/changing-the-colors.md#color-palette-toggle - [17]: ../setup/setting-up-navigation.md#back-to-top-button - #### $ 2,500 – Biquinho Vermelho - [x] [Search suggestions][18] @@ -222,11 +207,24 @@ _Goal reached :tada: – features will be merged in the next days!_ ### Goals completed -#### $ 500 – Madame Jeanette +#### $ 2,000 – Black Pearl -- [x] Improved search result grouping -- [x] Improved search result relevance and scoring -- [x] Missing query terms in search results +- [x] Latest release tag +- [x] [Color palette toggle][16] +- [x] [Back-to-top button][17] + + [16]: ../setup/changing-the-colors.md#color-palette-toggle + [17]: ../setup/setting-up-navigation.md#back-to-top-button + +#### $ 1,500 – Bhut Jolokia + +- [x] [Admonition inline blocks][12] +- [x] [Site language selection][13] +- [x] [Versioning][14] + + [12]: ../reference/admonitions.md#inline-blocks + [13]: ../setup/changing-the-language.md#site-language-selector + [14]: ../setup/setting-up-versioning.md#versioning #### $ 1,000 – Prairie Fire @@ -242,15 +240,11 @@ _Goal reached :tada: – features will be merged in the next days!_ [10]: ../setup/setting-up-navigation.md#navigation-integration [11]: ../setup/setting-up-the-header.md#automatic-hiding -#### $ 1,500 – Bhut Jolokia +#### $ 500 – Madame Jeanette -- [x] [Admonition inline blocks][12] -- [x] [Site language selection][13] -- [x] [Versioning][14] - - [12]: ../reference/admonitions.md#inline-blocks - [13]: ../setup/changing-the-language.md#site-language-selector - [14]: ../setup/setting-up-versioning.md#versioning +- [x] Improved search result grouping +- [x] Improved search result relevance and scoring +- [x] Missing query terms in search results ## Frequently asked questions diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index 64637e31c..79575605c 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -72,39 +72,14 @@ Some popular choices: [4]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons -### Latest release - -[:octicons-file-code-24: Source][5] · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][5]{ .mdx-insiders } - -The visual appearance of the repository link has been improved as part of -[Insiders][5], and will now automatically include the latest release tag which -is not marked as a draft or pre-release: - -
- -[![Search suggestions][6]][6] - -
- -A demo is worth a thousand words — check it out at -[squidfunk.github.io/mkdocs-material-insiders][7] - -
-
- - [5]: ../insiders/index.md - [6]: ../assets/screenshots/repository.png - [7]: https://squidfunk.github.io/mkdocs-material-insiders/setup/adding-a-git-repository/ - ### Edit button -[:octicons-file-code-24: Source][8] · :octicons-milestone-24: Default: +[:octicons-file-code-24: Source][5] · :octicons-milestone-24: Default: _automatically set_ -If the repository URL points to a [GitHub][9], [GitLab][10] or [Bitbucket][11] +If the repository URL points to a [GitHub][6], [GitLab][7] or [Bitbucket][8] repository, an _edit button_ is displayed at the top of each document. This -behavior can be changed by setting [`edit_uri`][12] in `mkdocs.yml`: +behavior can be changed by setting [`edit_uri`][9] in `mkdocs.yml`: === "Customize edit path" @@ -118,18 +93,18 @@ behavior can be changed by setting [`edit_uri`][12] in `mkdocs.yml`: edit_uri: "" ``` - [8]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html - [9]: https://github.com/ - [10]: https://about.gitlab.com/ - [11]: https://bitbucket.org/ - [12]: https://www.mkdocs.org/user-guide/configuration/#edit_uri + [5]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html + [6]: https://github.com/ + [7]: https://about.gitlab.com/ + [8]: https://bitbucket.org/ + [9]: https://www.mkdocs.org/user-guide/configuration/#edit_uri ### Revision date -[:octicons-file-code-24: Source][13] · -[:octicons-cpu-24: Plugin][14] +[:octicons-file-code-24: Source][10] · +[:octicons-cpu-24: Plugin][11] -The [git-revision-date][13] plugin adds support for displaying the date a +The [git-revision-date][10] plugin adds support for displaying the date a document was _last updated_ at the bottom of each page. It can be installed with `pip`: @@ -162,15 +137,15 @@ _Material for MkDocs doesn't provide official support for the other options of this plugin, so they may be supported but might yield unexpected results. Use them at your own risk._ - [13]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html - [14]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin + [10]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/source-date.html + [11]: https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin ### Revision date, localized -[:octicons-file-code-24: Source][13] · -[:octicons-cpu-24: Plugin][15] +[:octicons-file-code-24: Source][10] · +[:octicons-cpu-24: Plugin][12] -Similarly, the [git-revision-date-localized][15] plugin adds support for adding +Similarly, the [git-revision-date-localized][12] plugin adds support for adding a localized _last updated_ date at the bottom of each page. It can be installed with `pip`: @@ -215,4 +190,4 @@ _Material for MkDocs doesn't provide official support for the other options of this plugin, so they may be supported but might yield unexpected results. Use them at your own risk._ - [15]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin + [12]: https://github.com/timvink/mkdocs-git-revision-date-localized-plugin diff --git a/docs/setup/changing-the-colors.md b/docs/setup/changing-the-colors.md index 5cbb7018b..653a1ffbe 100644 --- a/docs/setup/changing-the-colors.md +++ b/docs/setup/changing-the-colors.md @@ -49,16 +49,6 @@ _Click on a tile to change the color scheme_: }) -The _color scheme_ can also be set based on _user preference_, which makes use -of the `prefers-color-scheme` media query, by setting the value in `mkdocs.yml` -to `preference`: - -``` yaml -theme: - palette: - scheme: preference -``` - [3]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/palette/_scheme.scss #### Primary color @@ -183,10 +173,7 @@ _Click on a tile to change the accent color_: ### Color palette toggle -[:octicons-file-code-24: Source][6] · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][6]{ .mdx-insiders } - -[Insiders][6] can easily add multiple color palettes, including a [scheme][8], +It's also possible to add multiple color palettes, including a [scheme][8], [primary][9] and [accent][10] color each, and let the user choose. A color palette toggle can be added via `mkdocs.yml`: diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 3ec05bce0..c8d223225 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -232,9 +232,8 @@ Note that it doesn't rely on third-party plugins[^2]._ ### Back-to-top button -[:octicons-file-code-24: Source][9] · -:octicons-unlock-24: Feature flag · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders } +[:octicons-file-code-24: Source][19] · +:octicons-unlock-24: Feature flag A _back-to-top button_ can be shown when the user, after scrolling down, starts to scroll up again. It's rendered in the lower right corner of the viewport. Add @@ -248,24 +247,25 @@ theme:
-[![back-to-top button][19]][19] +[![back-to-top button][20]][20]
A demo is worth a thousand words — check it out at -[squidfunk.github.io/mkdocs-material-insiders][20] +[squidfunk.github.io/mkdocs-material-insiders][21]
- [19]: ../assets/screenshots/back-to-top.png - [20]: https://squidfunk.github.io/mkdocs-material-insiders/setup/setting-up-navigation/#back-to-top-button + [19]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_top.scss + [20]: ../assets/screenshots/back-to-top.png + [21]: https://squidfunk.github.io/mkdocs-material-insiders/setup/setting-up-navigation/#back-to-top-button ### Table of contents -[:octicons-file-code-24: Source][21] · [:octicons-workflow-24: Extension][22] +[:octicons-file-code-24: Source][22] · [:octicons-workflow-24: Extension][23] -The [Table of contents][23] extension, which is part of the standard Markdown +The [Table of contents][24] extension, which is part of the standard Markdown library, provides some options that are supported by Material for MkDocs to customize its appearance: @@ -342,14 +342,14 @@ _Material for MkDocs doesn't provide official support for the other options of this extension, so they may be supported but might yield unexpected results. Use them at your own risk._ - [21]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/toc.html - [22]: https://python-markdown.github.io/extensions/toc/ - [23]: https://python-markdown.github.io/extensions/toc/#usage - [24]: https://facelessuser.github.io/pymdown-extensions/extras/slugs/ + [22]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/toc.html + [23]: https://python-markdown.github.io/extensions/toc/ + [24]: https://python-markdown.github.io/extensions/toc/#usage + [25]: https://facelessuser.github.io/pymdown-extensions/extras/slugs/ #### Navigation integration -[:octicons-file-code-24: Source][25] · +[:octicons-file-code-24: Source][26] · :octicons-unlock-24: Feature flag When _integration_ is enabled, the table of contents is rendered as part of @@ -364,14 +364,14 @@ theme: === "Integrate table of contents" - [![Integrate table of contents][26]][26] + [![Integrate table of contents][27]][27] === "Separate table of contents" [![Separate table of contents][7]][7] - [25]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_nav.scss - [26]: ../assets/screenshots/toc-integrate.png + [26]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_nav.scss + [27]: ../assets/screenshots/toc-integrate.png The content section will now always stretch to the right side, resulting in more space for your content. This feature flag can be combined with all other @@ -379,12 +379,12 @@ feature flags, e.g. [tabs][1] and [sections][2]. ### Hide the sidebars -[:octicons-file-code-24: Source][27] · +[:octicons-file-code-24: Source][28] · :octicons-note-24: Metadata Sometimes it's desirable to hide the navigation and/or table of contents sidebar, especially when there's a single navigation item. This can be done for -any page using the [Metadata][28] extension: +any page using the [Metadata][29] extension: ``` yaml --- @@ -398,27 +398,27 @@ hide: === "Hide navigation" - [![Hide navigation][29]][29] + [![Hide navigation][30]][30] === "Hide table of contents" - [![Hide table of contents][30]][30] + [![Hide table of contents][31]][31] === "Hide both" - [![Hide navigation and table of contents][31]][31] + [![Hide navigation and table of contents][32]][32] - [27]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html - [28]: ../../reference/meta-tags/#metadata - [29]: ../assets/screenshots/hide-navigation.png - [30]: ../assets/screenshots/hide-toc.png - [31]: ../assets/screenshots/hide-navigation-toc.png + [28]: https://github.com/squidfunk/mkdocs-material/blob/master/src/base.html + [29]: ../../reference/meta-tags/#metadata + [30]: ../assets/screenshots/hide-navigation.png + [31]: ../assets/screenshots/hide-toc.png + [32]: ../assets/screenshots/hide-navigation-toc.png ## Customization ### Keyboard shortcuts -[:octicons-file-code-24: Source][32] · +[:octicons-file-code-24: Source][33] · :octicons-mortar-board-24: Difficulty: _easy_ Material for MkDocs includes several keyboard shortcuts that make it possible @@ -444,7 +444,7 @@ to navigate your project documentation via keyboard. There're two modes: * ++n++ , ++period++ : go to next page Let's say you want to bind some action to the ++x++ key. By using [additional -JavaScript][33], you can subscribe to the `keyboard$` observable and attach +JavaScript][34], you can subscribe to the `keyboard$` observable and attach your custom event listener: ``` js @@ -460,12 +460,12 @@ The call to `#!js key.claim()` will essentially execute `#!js preventDefault()` on the underlying event, so the keypress will not propagate further and touch other event listeners. - [32]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/keyboard/index.ts - [33]: ../customization.md#additional-javascript + [33]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/javascripts/integrations/keyboard/index.ts + [34]: ../customization.md#additional-javascript ### Content area width -[:octicons-file-code-24: Source][34] · +[:octicons-file-code-24: Source][35] · :octicons-mortar-board-24: Difficulty: _easy_ The width of the content area is set so the length of each line doesn't exceed @@ -474,7 +474,7 @@ is a reasonable default, as longer lines tend to be harder to read, it may be desirable to increase the overall width of the content area, or even make it stretch to the entire available space. -This can easily be achieved with an [additional stylesheet][35] and a few lines +This can easily be achieved with an [additional stylesheet][36] and a few lines of CSS: === "Increase width" @@ -493,5 +493,5 @@ of CSS: } ``` - [34]: https://github.com/squidfunk/mkdocs-material/blob/aeaa00a625abf952f355164de02c539b061e6127/src/assets/stylesheets/main/layout/_base.scss - [35]: ../customization.md#additional-css + [35]: https://github.com/squidfunk/mkdocs-material/blob/aeaa00a625abf952f355164de02c539b061e6127/src/assets/stylesheets/main/layout/_base.scss + [36]: ../customization.md#additional-css diff --git a/material/base.html b/material/base.html index 846f8d0dc..7f8b8e441 100644 --- a/material/base.html +++ b/material/base.html @@ -27,7 +27,7 @@ {% endif %} - + {% endblock %} {% block htmltitle %} {% if page and page.meta and page.meta.title %} diff --git a/package-lock.json b/package-lock.json index 76e8ea171..84737a423 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "7.0.7", + "version": "7.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index a67b2b8b5..3a700c9a9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "7.0.7", + "version": "7.1.0", "description": "A Material Design theme for MkDocs", "keywords": [ "mkdocs",