mkdocs-awesome-pages-plugin

Improvements

• Support for mkdocs-gen-files #78

Bugfixes

• Fix .pages in sections under virtual section #77

Bugfixes

• Fix order_by: title in combination with custom section titles #73

Features

• Sort by page title using order_by: title
• Set defaults for order, sort_type and order_by in plugin options

Features

• Support for natural sorting with sort_type: natural

Features

• Items can now be grouped into sections

Improvements

• Add warning if preceding plugins define a on_nav listener that might get overridden

Bugfixes

• Restrict mkdocs.yml nav workaround to cases where it's necessary

Features

• Remaining pages can now be flattened by adding | flat to the ... entry.

Bugfixes

• Fix collections import (Python 3.10) #49

Features

• Remaining pages can now be filtered by adding a glob pattern or regex to the ... entry.

Features

• The ... entry is now supported in nav of mkdocs.yml as well
  Interoperability with nav has been improved in general. The plugin now leaves manually defined navigation sections untouched.

Bugfixes

• Fix compatibility issue with mktheapidocs #17

Features

• More powerful navigation customization using nav
  • Hide navigation entries
  • Override titles
  • Add links
• Change the sort order using order

Deprecations

• The arrange attribute is now deprecated in favor of nav and will be removed in the next major release.

Bugfixes

• Make plugin compatible with MkDocs 1.1 #18

Features

• New strict option which can be set to false to receive warnings instead of errors when arrange entries cannot be found.

Features

• Hide directories in the navigation using the new hide attribute

Bugfixes

• Use yaml.safe_load instead of yaml.load #8

Bugfixes

• Prevent error when using with MkDocs 1.0
  In this version the plugin doesn't properly work with MkDocs 1.0, use the latest version instead

Features

• Support for MkDocs 1.0
  If you're still on MkDocs 0.17 use version 1 of this plugin.

Breaking Changes

• The disable_auto_arrange_index plugin option has been removed
  MkDocs 1.0 includes this feature out-of-the-box, therefore it has been removed from the plugin entirely

Notes

Two features have been removed because MkDocs 1.0 implements them out-of-the-box:

• Extracting page titles from Markdown
• Displaying index pages at the top

This release doesn't contain any real changes, it just adjusts the MkDocs version requirement.
Version 1 of the plugin is only compatible with MkDocs 0.17. For MkDocs 1.0 use the latest version of the plugin.

Improvements

• Collapsing single pages can be configured in the .pages file and allow to use the feature selectively