awsome-pages Plugin

Description¶

Essential MkDocs Navi Plugin

The aptly-named awesome-pages plulgin adds automatic and specific dir-based navi, without polluting mkdocs.yml. For detailed usage instructions see mkdocs-aweome-pages-plugin.

Install¶

In the project venv:

pip install mkdocs-awesome-pages-plugin

Usage¶

Create a .pages file in a dir:

nav:
  - index.md
  - first-sub-dir
  - first-page.md
  - ... | intro-*.md # all starting with "intro"
  - ... # all remaining entries
  - Title Text: some-page.md # Provide a title 
  - Link Title: https://some-site.com
  - last-page.md

Rest Filter¶

Lines beginning with ... are called Rest Filters.

A rest filter applies to items in the containing folder.

Custom Sections¶

nav:
  - index.md
  - section 1:
      - page1.md
      - page2.md
  - Section 2:
      - another-page.md

Comments