mkdocs include directory to navigation

How I can include all directory in mkdocs navigation ? Use this plugin 👍

This is a plugin that fetch navigation menu (in mkdocs.yaml) and replace directory by files. Mkdocs, do not expand folder, this do.

Modification are make 'on the fly' during Build ou Serve, your mkdocs.yaml file will not be modified.

Features :

• Scan navigation for replace folder to all sub file
• Recurcive scan into folder
• Accept all classic mkdocs file type (direct reference, reference with title ...)
• Convert sub folder to section
• Options :
  • flat : Disable sub folder as section (default=True)
  • file_name_as_title : Usine file name as title instead of let mkdocs detect H1 balise in file (default=False)
  • recurse : disabled nested search in folder (default=True)
  • file_pattern : Regex for select markdown file (default '.*\.md$')
  • sort_file : Sort file (default=True)
  • sort_directory : Sort directory (default=True)
  • reverse_sort_file : Sort file in reverse order (default=False)
  • reverse_sort_directory : Sort file in reverse order (default=False)
  • include_empty_dir : Include all subDir (event if no valid document is present) (default=False)

If you need more features, look at mkdocs-awesome-pages-plugin than seem to make many more think.

Setup

Install the plugin using pip:

pip install mkdocs-include-dir-to-nav

Usage

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - include_dir_to_nav

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

Then, specify folders in your navigation (as always, folder from docs_site path):

nav:
  - Home: README.md
  - dirDirectRef
  - SubDirDirectRef/SubDirDirectRefSub
  - emptyDir
  - dirNamed: dirNamed
  - SubDirNamed: SubDirNamed/SubDirNamedSub
  - dirDirectRefUnderMenu:
    - dirDirectRefUnderMenu
    - dirNamedUnderMenu: dirNamedUnderMenu

Each navigation path will be scan, if elements is directory, it will be expand and all sub file will be add.

Options

• flat : Disable sub folder as section
• file_name_as_title : Usine file name as title instead of let mkdocs detect H1 balise in file
• recurse : disabled nested search in folder
• file_pattern : Regex for select markdown file (default '.*\.md$')

Basic example, for folder :

docs/
├── README.md
├── dirDirectRef
│   ├── dirDirectRef-page01.md
│   ├── dirDirectRef-page02.md
│   └── dirDirectRefSub
│       ├── dirDirectRefSub-page01.md
│       └── dirDirectRefSub-page02.md
├── dirNamedUnderMenu
│   ├── dirNamedUnderMenu-page01.md
│   ├── dirNamedUnderMenu-page02.md
│   └── dirNamedUnderMenuSub
│       ├── dirNamedUnderMenuSub-page01.md
│       └── dirNamedUnderMenuSub-page02.md
└── emptyDir

with mkdocs.yaml base :

docs_dir: './docs'

nav:
  - Home: README.md
  - dirDirectRef
  - dirNamed: dirNamed

Without option

plugins:
  - search
  - include_dir_to_nav:

Result :

- Home: README.md
- dirDirectRef/dirDirectRef-page01.md
- dirDirectRef/dirDirectRef-page02.md
- dirDirectRefSub:
    - dirDirectRef/dirDirectRefSub/dirDirectRefSub-page02.md
    - dirDirectRef/dirDirectRefSub/dirDirectRefSub-page01.md
- dirNamed:
    - dirNamed/dirNamed-page01.md
    - dirNamed/dirNamed-page02.md
    - dirNamedSub:
        - dirNamed/dirNamedSub/dirNamedSub-page01.md
        - dirNamed/dirNamedSub/dirNamedSub-page02.md

file_pattern option

plugins:
  - search
  - include_dir_to_nav:
      file_pattern: '.*01\.md$'

Result :

- Home: README.md
- dirDirectRef/dirDirectRef-page01.md
- dirDirectRefSub:
    - dirDirectRef/dirDirectRefSub/dirDirectRefSub-page01.md
- dirNamed:
    - dirNamed/dirNamed-page01.md
    - dirNamedSub:
        - dirNamed/dirNamedSub/dirNamedSub-page01.md

recurse option

plugins:
  - search
  - include_dir_to_nav:
      recurse: false

Result :

- Home: README.md
- dirDirectRef/dirDirectRef-page01.md
- dirDirectRef/dirDirectRef-page02.md
- dirNamed:
    - dirNamed/dirNamed-page01.md
    - dirNamed/dirNamed-page02.md

Flat option

plugins:
  - search
  - include_dir_to_nav:
      flat: true

Result :

- Home: README.md
- dirDirectRef/dirDirectRef-page01.md
- dirDirectRef/dirDirectRef-page02.md
- dirDirectRef/dirDirectRefSub/dirDirectRefSub-page02.md
- dirDirectRef/dirDirectRefSub/dirDirectRefSub-page01.md
- dirNamed:
    - dirNamed/dirNamed-page01.md
    - dirNamed/dirNamed-page02.md
    - dirNamed/dirNamedSub/dirNamedSub-page01.md
    - dirNamed/dirNamedSub/dirNamedSub-page02.md

file_name_as_title option

plugins:
  - search
  - include_dir_to_nav:
      file_name_as_title: true

Result :

- Home: README.md
- dirDirectRef-page01: dirDirectRef/dirDirectRef-page01.md
- dirDirectRef-page02: dirDirectRef/dirDirectRef-page02.md
- dirDirectRefSub:
    - dirDirectRefSub-page02: dirDirectRef/dirDirectRefSub/dirDirectRefSub-page02.md
    - dirDirectRefSub-page01: dirDirectRef/dirDirectRefSub/dirDirectRefSub-page01.md
- dirNamed:
    - dirNamed-page01: dirNamed/dirNamed-page01.md
    - dirNamed-page02: dirNamed/dirNamed-page02.md
    - dirNamedSub:
        - dirNamedSub-page01: dirNamed/dirNamedSub/dirNamedSub-page01.md
        - dirNamedSub-page02: dirNamed/dirNamedSub/dirNamedSub-page02.md

Sort option

Options :

• sort_file : Sort file (default=True)
• sort_directory : Sort directory (default=True)
• reverse_sort_file : Sort file in reverse order (default=False)
• reverse_sort_directory : Sort file in reverse order (default=False)

plugins:
  - search
  - include_dir_to_nav:
      sort_file: true
      sort_directory: true

Result :

- aafolder:
  - fold_sort/aafolder/0page.md
  - fold_sort/aafolder/Cpage.md
  - fold_sort/aafolder/apage.md
  - fold_sort/aafolder/bpage.md
  - fold_sort/aafolder/page-with-header.md
  - fold_sort/aafolder/page-with-no-header.md
  - fold_sort/aafolder/zpage.md
- ccfolder:
  - fold_sort/ccfolder/apage.md
  - fold_sort/ccfolder/zpage.md
- zzfolder:
  - fold_sort/zzfolder/apage.md
  - fold_sort/zzfolder/zpage.md

plugins:
  - search
  - include_dir_to_nav:
      sort_file: true
      sort_directory: true
      reverse_sort_directory: true

Result :

- zzfolder:
  - fold_sort/zzfolder/apage.md
  - fold_sort/zzfolder/zpage.md
- ccfolder:
  - fold_sort/ccfolder/apage.md
  - fold_sort/ccfolder/zpage.md
- aafolder:
  - fold_sort/aafolder/0page.md
  - fold_sort/aafolder/Cpage.md
  - fold_sort/aafolder/apage.md
  - fold_sort/aafolder/bpage.md
  - fold_sort/aafolder/page-with-header.md
  - fold_sort/aafolder/page-with-no-header.md
  - fold_sort/aafolder/zpage.md

More 'complexe' example in test folder.

Contribution

Feel free to add issue, arange code and/or make PR

Tests

Find into test folder a basic mkdocs.yaml and sub folder in order to test plugin.

Use mkdocs build -v in order to show debug message.

Publish

Update changelog, readme and setup.py. Push code and PR.

Build code : python3 -m build

Publish in test pypi : python3 -m twine upload --repository testpypi dist/*

Publish in pypi : python3 -m twine upload dist/*

Personal note

It's my first python code, so be indulgent and optimize it if needed ;)