From ba1f021c7658e54d28f2737d0960f8258abfb320 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 23 Sep 2021 09:23:42 +0200 Subject: [PATCH] Prepare 7.3.0 release --- CHANGELOG | 6 ++ docs/changelog.md | 6 ++ docs/insiders/index.md | 23 ++++---- docs/setup/setting-up-navigation.md | 90 +++++++++++++---------------- docs/setup/setting-up-the-footer.md | 15 ++++- material/base.html | 2 +- package-lock.json | 2 +- package.json | 2 +- 8 files changed, 79 insertions(+), 67 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 9403988d5..1872aec72 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,9 @@ +mkdocs-material-7.3.0 (2021-09-23) + + * Added support for sticky navigation tabs + * Added support for section index pages + * Added support for removing generator notice + mkdocs-material-7.2.8 (2021-09-20) * Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression) diff --git a/docs/changelog.md b/docs/changelog.md index 3a7fd8e6a..d456ee427 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -6,6 +6,12 @@ template: overrides/main.html ## Material for MkDocs +### 7.3.0 _ September 23, 2021 + +- Added support for sticky navigation tabs +- Added support for section index pages +- Added support for removing generator notice + ### 7.2.8 _ September 20, 2021 - Fixed #3039: Search modal overlays menu on mobile (7.2.7 regression) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 1645f5727..5c4e0e6d9 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -151,10 +151,7 @@ The following features are currently exclusively available to sponsors: - [x] [Custom admonition icons][31] - [x] [Code block annotations][25] - [x] [Anchor tracking ][24] -- [x] [Section index pages][22] -- [x] [Sticky navigation tabs][21] - [x] [Mermaid.js integration][27] -- [x] [Remove generator notice][23] @@ -172,16 +169,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. -#### $ 3,000 – Caribbean Red - -- [x] [Sticky navigation tabs][21] -- [x] [Section index pages][22] -- [x] [Remove generator notice][23] - - [21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs - [22]: ../setup/setting-up-navigation.md#section-index-pages - [23]: ../setup/setting-up-the-footer.md#remove-generator - #### $ 4,000 – Ghost Pepper - [x] [Anchor tracking][24] @@ -242,6 +229,16 @@ the public for general availability. ### Goals completed +#### $ 3,000 – Caribbean Red + +- [x] [Sticky navigation tabs][21] +- [x] [Section index pages][22] +- [x] [Remove generator notice][23] + + [21]: ../setup/setting-up-navigation.md#sticky-navigation-tabs + [22]: ../setup/setting-up-navigation.md#section-index-pages + [23]: ../setup/setting-up-the-footer.md#remove-generator + #### $ 2,500 – Biquinho Vermelho - [x] [Search suggestions][18] diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 6200d33b6..26d0f89dd 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -43,9 +43,9 @@ _Material for MkDocs is the only MkDocs theme offering this feature._ ### Anchor tracking -[:octicons-file-code-24: Source][9] · +[:octicons-file-code-24: Source][6] · :octicons-unlock-24: Feature flag · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders } +[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][6]{ .mdx-insiders } When _anchor tracking_ is enabled, the URL in the address bar is automatically updated with the active anchor as highlighted in the table of contents. Add the @@ -57,9 +57,11 @@ theme: - navigation.tracking ``` + [6]: ../insiders/index.md + ### Navigation tabs -[:octicons-file-code-24: Source][6] · :octicons-unlock-24: Feature flag +[:octicons-file-code-24: Source][7] · :octicons-unlock-24: Feature flag When _tabs_ are enabled, top-level sections are rendered in a menu layer below the header for viewports above `1220px`, but remain as-is on mobile.[^1] Add @@ -82,22 +84,21 @@ theme: === "With tabs" - [![With tabs][7]][7] + [![With tabs][8]][8] === "Without tabs" - [![Without tabs][8]][8] + [![Without tabs][9]][9] - [6]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/tabs.html - [7]: ../assets/screenshots/navigation-tabs.png - [8]: ../assets/screenshots/navigation.png + [7]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/tabs.html + [8]: ../assets/screenshots/navigation-tabs.png + [9]: ../assets/screenshots/navigation.png #### Sticky navigation tabs -[:octicons-file-code-24: Source][9] · +[:octicons-file-code-24: Source][10] · :octicons-unlock-24: Feature flag · -:octicons-beaker-24: Experimental · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders } +:octicons-beaker-24: Experimental When _sticky tabs_ are enabled, navigation tabs will lock below the header and always remain visible when scrolling down. Just add the following two feature @@ -112,19 +113,19 @@ theme: === "With sticky tabs" - [![With sticky tabs][10]][10] + [![With sticky tabs][11]][11] === "Without sticky tabs" - [![Without sticky tabs][11]][11] + [![Without sticky tabs][12]][12] - [9]: ../insiders/index.md - [10]: ../assets/screenshots/navigation-tabs-sticky.png - [11]: ../assets/screenshots/navigation-tabs-collapsed.png + [10]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/header.html + [11]: ../assets/screenshots/navigation-tabs-sticky.png + [12]: ../assets/screenshots/navigation-tabs-collapsed.png ### Navigation sections -[:octicons-file-code-24: Source][12] · +[:octicons-file-code-24: Source][13] · :octicons-unlock-24: Feature flag When _sections_ are enabled, top-level sections are rendered as groups in the @@ -139,14 +140,14 @@ theme: === "With sections" - [![With sections][13]][13] + [![With sections][14]][14] === "Without sections" - [![Without sections][8]][8] + [![Without sections][9]][9] - [12]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html - [13]: ../assets/screenshots/navigation-sections.png + [13]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html + [14]: ../assets/screenshots/navigation-sections.png Both feature flags, _tabs_ and _sections_, can be combined with each other. If both feature flags are enabled, sections are rendered for level 2 navigation @@ -154,7 +155,7 @@ items. ### Navigation expansion -[:octicons-file-code-24: Source][12] · +[:octicons-file-code-24: Source][13] · :octicons-unlock-24: Feature flag When _expansion_ is enabled, the left sidebar will expand all collapsible @@ -169,20 +170,19 @@ theme: === "With expansion" - [![With expansion][14]][14] + [![With expansion][15]][15] === "Without expansion" - [![Without expansion][8]][8] + [![Without expansion][9]][9] - [14]: ../assets/screenshots/navigation-expand.png + [15]: ../assets/screenshots/navigation-expand.png ### Section index pages -[:octicons-file-code-24: Source][9] · +[:octicons-file-code-24: Source][16] · :octicons-unlock-24: Feature flag · -:octicons-beaker-24: Experimental · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][9]{ .mdx-insiders } +:octicons-beaker-24: Experimental When _section index pages_ are enabled, documents can be directly attached to sections, which is particularly useful for providing overview pages. Add the @@ -196,11 +196,11 @@ theme: === "With section index pages" - [![With expansion][15]][15] + [![With expansion][17]][17] === "Without section index pages" - [![Without expansion][16]][16] + [![Without expansion][18]][18] In order to link a page to a section, create a new document with the name `index.md` in the respective folder, and add it to the beginning of your @@ -216,23 +216,16 @@ nav: ``` _This feature flag can be combined with all other feature flags, e.g. [tabs][1] -and [sections][2], except for table of contents [navigation integration][17]. -Note that it doesn't rely on third-party plugins[^2]._ +and [sections][2], except for table of contents [navigation integration][19]._ - [^2]: - If you don't want to use the native integration, the - [mkdocs-section-index][18] plugin might be an alternative. However, note - that this plugin may not be compatible with all navigation-related features - offered by Material for MkDocs. - - [15]: ../assets/screenshots/navigation-index-on.png - [16]: ../assets/screenshots/navigation-index-off.png - [17]: #navitation-intergation - [18]: https://github.com/oprypin/mkdocs-section-index + [16]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/nav-item.html + [17]: ../assets/screenshots/navigation-index-on.png + [18]: ../assets/screenshots/navigation-index-off.png + [19]: #navigation-integration ### Back-to-top button -[:octicons-file-code-24: Source][19] · +[:octicons-file-code-24: Source][20] · :octicons-unlock-24: Feature flag A _back-to-top button_ can be shown when the user, after scrolling down, starts @@ -245,11 +238,10 @@ theme: - navigation.top ``` -[![back-to-top button][20]][20] +[![back-to-top button][21]][21] - [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 + [20]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_top.scss + [21]: ../assets/screenshots/back-to-top.png ### Table of contents @@ -287,7 +279,7 @@ customize its appearance: : :octicons-milestone-24: Default: `headerid.slugify` – This option allows for customization of the slug function. For some languages, the default may not produce good and readable identifiers – consider using another slug function - like for example those from [Python Markdown Extensions][24]: + like for example those from [Python Markdown Extensions][25]: === "Unicode" @@ -358,7 +350,7 @@ theme: === "Separate table of contents" - [![Separate table of contents][7]][7] + [![Separate table of contents][8]][8] [26]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/layout/_nav.scss [27]: ../assets/screenshots/toc-integrate.png diff --git a/docs/setup/setting-up-the-footer.md b/docs/setup/setting-up-the-footer.md index dcb368520..9f51c6735 100644 --- a/docs/setup/setting-up-the-footer.md +++ b/docs/setup/setting-up-the-footer.md @@ -105,8 +105,7 @@ copyright: Copyright © 2016 - 2020 Martin Donath ### Remove generator -[:octicons-file-code-24: Source][4] · -[:octicons-heart-fill-24:{ .mdx-heart } Insiders only][4]{ .mdx-insiders } +[:octicons-file-code-24: Source][3] The footer displays a _Made with Material for MkDocs_ notice to denote how the site was generated. The notice can be removed with the following setting @@ -117,6 +116,18 @@ extra: generator: false ``` +!!! info "Please read this before removing the generator notice" + + The subtle __Made with Material for MkDocs__ hint in the footer is one of + the reasons why this project is so popular, as it tells the user how the + site is generated, helping new users to discover this project. Before + removing it, please consider that you're enjoying the benefits of + @squidfunk's work for free, as this project is Open Source and has a + permissive license. Thousands of hours went into this project, most of them + without any financial return. Thus, if you remove this notice, please + consider [sponsoring][4] the project. __Thank you__ + :octicons-heart-fill-24:{ .mdx-heart .mdx-insiders } + [4]: ../insiders/index.md ## Customization diff --git a/material/base.html b/material/base.html index 3766f3d08..12b216c3a 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 f65161e72..e2657425c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "7.2.8", + "version": "7.3.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 18b952b65..306c6cda5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mkdocs-material", - "version": "7.2.8", + "version": "7.3.0", "description": "A Material Design theme for MkDocs", "keywords": [ "mkdocs",