github mysiki/mkdocs_include_dir_to_nav v1.0.0

latest releases: v1.2.0, v1.1.0
5 years ago

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
    • 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$')

Don't miss a new mkdocs_include_dir_to_nav release

NewReleases is sending notifications on new releases.