Skip to main content

mkdocs-navsorted-plugin

https://github.com/idlesign/mkdocs-navsorted-plugin

PyPI - Version License Coverage Docs

Description

mkdocs plugin to get nav sorted without yml directives

Use numeric prefixes for your documentation files/directories names to drive navigation items sort order.

Normal layout:

docs
|- section_a
|   |- file1.md
|   |- file2.md
|- section_b
|   |- file3.md
|   |- file4.md
|- about.md
|- index.md
|- quickstart.md

We turn into a prefixed one:

docs
|- 01_index.md
|- 10_quickstart.md
|- 20_section_a
|   |- 10_file2.md
|   |- 20_file1.md
|- 30_section_b
|   |- file3.md
|   |- file4.md
|- 40_about.md

So the navigation with this plugin would become:

index
quickstart
section_a
  file2
  file1
section_b
  file3
  file4
about

Read the documentation.

Documentation

https://mkdocs-navsorted-plugin.readthedocs.io

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_navsorted_plugin-1.0.0.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_navsorted_plugin-1.0.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_navsorted_plugin-1.0.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_navsorted_plugin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e24bf490133af87cf3cce5b9674ca9d99e5d8f070e253aedacce87dffb045667
MD5 c2d33ed5cfc1cac54e4d2c5851f7093e
BLAKE2b-256 cf65e945b63d83a3dbd3c0255ba24ed3f164ef9c6bcd0fb38b84189e98593083

See more details on using hashes here.

File details

Details for the file mkdocs_navsorted_plugin-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_navsorted_plugin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ad8a6f19916994cd294bdd196edbd6e3d0b60f9136ccae059254ab73a337fba
MD5 8672f570c7bee75c593f40555ff4e30c
BLAKE2b-256 30a0908d48a62baa3b124ae1d658966d84fc8c4c7707cef40b4c9d8a6fc92cc2

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page