diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mkdocs-awesome-pages-plugin.spec | 65 | ||||
| -rw-r--r-- | sources | 2 |
3 files changed, 60 insertions, 8 deletions
@@ -1 +1,2 @@ /mkdocs-awesome-pages-plugin-2.8.0.tar.gz +/mkdocs_awesome_pages_plugin-2.9.0.tar.gz diff --git a/python-mkdocs-awesome-pages-plugin.spec b/python-mkdocs-awesome-pages-plugin.spec index bc97cd7..5d68381 100644 --- a/python-mkdocs-awesome-pages-plugin.spec +++ b/python-mkdocs-awesome-pages-plugin.spec @@ -1,11 +1,11 @@ %global _empty_manifest_terminate_build 0 Name: python-mkdocs-awesome-pages-plugin -Version: 2.8.0 +Version: 2.9.0 Release: 1 Summary: An MkDocs plugin that simplifies configuring page titles and their order License: MIT URL: https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/ -Source0: https://mirrors.nju.edu.cn/pypi/web/packages/18/39/22aa311684b56104ea74c34dae7008cfd609388bbd0bdbb7229b515e89ba/mkdocs-awesome-pages-plugin-2.8.0.tar.gz +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f4/a8/82e91af94dbb463774ba9660537194edb13745c9cb77691c44916cc29399/mkdocs_awesome_pages_plugin-2.9.0.tar.gz BuildArch: noarch Requires: python3-mkdocs @@ -25,7 +25,7 @@ The awesome-pages plugin allows you to customize how your pages show up the navi ## Installation -> **Note:** This package requires Python >=3.5 and MkDocs version 1.0 or higher. +> **Note:** This package requires Python >=3.7 and MkDocs version 1.0 or higher. > If you're still on MkDocs 0.17 use [version 1 of this plugin][github-v1]. Install the package with pip: @@ -141,6 +141,16 @@ This can be combined with `order` above. sort_type: natural ``` +### Order Navigation By Preference + +Create a file named `.pages` in a directory and set the `order_by` attribute to `filename` or `title` to change the order of navigation items. + +```yaml +order_by: title +``` + +This can be combined with `order` and/or `sort_type` above. If `order` is not set it will order ascending. If no preference is set, it will order by filename. + ### Collapse Single Nested Pages > **Note:** This feature is disabled by default. More on how to use it below @@ -395,6 +405,9 @@ plugins: filename: .index collapse_single_pages: true strict: false + order: asc + sort_type: natural + order_by: title ``` ### `filename` @@ -414,6 +427,10 @@ Raise errors instead of warnings when: Default is `true` +### `order`, `sort_type` and `order_by` + +Global fallback values for the Meta attributes. Default is `None` or `filename`. + <br/> ## Contributing @@ -449,7 +466,7 @@ The awesome-pages plugin allows you to customize how your pages show up the navi ## Installation -> **Note:** This package requires Python >=3.5 and MkDocs version 1.0 or higher. +> **Note:** This package requires Python >=3.7 and MkDocs version 1.0 or higher. > If you're still on MkDocs 0.17 use [version 1 of this plugin][github-v1]. Install the package with pip: @@ -565,6 +582,16 @@ This can be combined with `order` above. sort_type: natural ``` +### Order Navigation By Preference + +Create a file named `.pages` in a directory and set the `order_by` attribute to `filename` or `title` to change the order of navigation items. + +```yaml +order_by: title +``` + +This can be combined with `order` and/or `sort_type` above. If `order` is not set it will order ascending. If no preference is set, it will order by filename. + ### Collapse Single Nested Pages > **Note:** This feature is disabled by default. More on how to use it below @@ -819,6 +846,9 @@ plugins: filename: .index collapse_single_pages: true strict: false + order: asc + sort_type: natural + order_by: title ``` ### `filename` @@ -838,6 +868,10 @@ Raise errors instead of warnings when: Default is `true` +### `order`, `sort_type` and `order_by` + +Global fallback values for the Meta attributes. Default is `None` or `filename`. + <br/> ## Contributing @@ -870,7 +904,7 @@ The awesome-pages plugin allows you to customize how your pages show up the navi ## Installation -> **Note:** This package requires Python >=3.5 and MkDocs version 1.0 or higher. +> **Note:** This package requires Python >=3.7 and MkDocs version 1.0 or higher. > If you're still on MkDocs 0.17 use [version 1 of this plugin][github-v1]. Install the package with pip: @@ -986,6 +1020,16 @@ This can be combined with `order` above. sort_type: natural ``` +### Order Navigation By Preference + +Create a file named `.pages` in a directory and set the `order_by` attribute to `filename` or `title` to change the order of navigation items. + +```yaml +order_by: title +``` + +This can be combined with `order` and/or `sort_type` above. If `order` is not set it will order ascending. If no preference is set, it will order by filename. + ### Collapse Single Nested Pages > **Note:** This feature is disabled by default. More on how to use it below @@ -1240,6 +1284,9 @@ plugins: filename: .index collapse_single_pages: true strict: false + order: asc + sort_type: natural + order_by: title ``` ### `filename` @@ -1259,6 +1306,10 @@ Raise errors instead of warnings when: Default is `true` +### `order`, `sort_type` and `order_by` + +Global fallback values for the Meta attributes. Default is `None` or `filename`. + <br/> ## Contributing @@ -1276,7 +1327,7 @@ If you want to contribute to the code of this project, please read the [Contribu %prep -%autosetup -n mkdocs-awesome-pages-plugin-2.8.0 +%autosetup -n mkdocs-awesome-pages-plugin-2.9.0 %build %py3_build @@ -1316,5 +1367,5 @@ mv %{buildroot}/doclist.lst . %{_docdir}/* %changelog -* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 2.8.0-1 +* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 2.9.0-1 - Package Spec generated @@ -1 +1 @@ -878575f26171fd3671872dbb3fa57b8c mkdocs-awesome-pages-plugin-2.8.0.tar.gz +d06318b1d90e93e3caac240a33cdc4ec mkdocs_awesome_pages_plugin-2.9.0.tar.gz |