Registry / web-framework / mkdocs-awesome-pages-plugin

mkdocs-awesome-pages-plugin

library2.10.1pypypi✓ verified 22d ago

This is an MkDocs plugin that simplifies configuring page titles and their order using `.pages` files. This package represents versions prior to 3.0.0. As of version 3.0.0, the plugin has been completely rewritten, renamed to `mkdocs-awesome-nav`, and is distributed under a new PyPI package. This specific package (`mkdocs-awesome-pages-plugin`) is no longer actively developed and is considered deprecated in favor of `mkdocs-awesome-nav`.

web-framework

pip install mkdocs-awesome-pages-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · MKDOCS-AWESOME-PAG

mkdocs-awesome-pages-plugin

web-frameworkpythonv2.10.1

Install

3.8s avg

Import

—

Disk

33MB

Pass rate

8/ 10

Env Coverage8 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.10.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

glibc

py 3.10

✓ —

✓ 4.25s

py 3.11

✓ —

✓ 4.05s

py 3.12

✓ —

✓ 3.45s

py 3.13

✓ —

✓ 3.55s

py 3.9

1/2 runs

33MB installed

● package 33MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

awesome-pages

✓ plugins: - awesome-pages

✗ plugins: - mkdocs-awesome-pages-plugin

MkDocs plugins are referenced by their entrypoint name (e.g., 'awesome-pages') in `mkdocs.yml`, not their full PyPI package name.

To use the plugin, add `awesome-pages` to the `plugins` section of your `mkdocs.yml` file. Then, define page titles, order, and hierarchy within your documentation directories using `.pages` files, where `nav` specifies the order and `title` sets the section's name in the navigation.

# mkdocs.yml site_name: My Awesome Docs plugins: - awesome-pages # docs/index.md # My Home Page # docs/section/.pages # title: Section Title for Menu # nav: # - page-one.md # - page-two.md # - sub-section/ # docs/section/page-one.md # Content for Page One

Debug

Known issues

breakingBreaking Change: Plugin Renamed and Rewritten in v3.0.0. Version 3.0.0 of this plugin was a complete rewrite, renamed to `mkdocs-awesome-nav`, and released under a new PyPI package. The new version introduces a different approach to navigation generation, leading to breaking changes in configuration and behavior.

fix

Migrate to `mkdocs-awesome-nav`. Install `pip install mkdocs-awesome-nav` and consult its documentation for updated configuration details and `.pages` file syntax. If you must use the old behavior, pin your `mkdocs-awesome-pages-plugin` version to `<3.0.0`.

affects: All versions >= 3.0.0 (under the new `mkdocs-awesome-nav` package)

deprecatedThis package (`mkdocs-awesome-pages-plugin`) is deprecated. Development has moved to the `mkdocs-awesome-nav` package.

fix

Upgrade to `mkdocs-awesome-nav` for new features, bug fixes, and ongoing support. The new package is `mkdocs-awesome-nav`.

affects: All versions of `mkdocs-awesome-pages-plugin` (2.x.x series)

gotchaIncorrect Plugin Name in `mkdocs.yml`. A common mistake is to specify the full PyPI package name (`mkdocs-awesome-pages-plugin`) in the `plugins` section of `mkdocs.yml`.

fix

Always use the registered entrypoint name, which is `awesome-pages`, in your `mkdocs.yml` configuration: `plugins: - awesome-pages`.

affects: All versions

Upgrade

Version history

2.10.1latest on PyPI · released Dec 22, 2024

Audit

Dependencies

MkDocsrequiredThis is an MkDocs plugin and requires MkDocs to function.

Agent activity

21 hits · last 30 days

node

Resources

githubhttps://github.com/lukasgeiter/mkdocs-awesome-pages-plugin ↗

packagehttps://pypi.org/project/mkdocs-awesome-pages-plugin/ ↗