mkdocs-literate-nav icon indicating copy to clipboard operation
mkdocs-literate-nav copied to clipboard

documentation improves on how this plugin works

Open kratsg opened this issue 2 years ago • 0 comments

This threw me for a loop because I forgot how the plugin works, so perhaps some documentation could be added along the lines of:

"This plugin looks for files named by the filename specified in nav_file and replaces the default navigation with it, wherever it finds it."

(related: nav_file has to be a filename only, if it's folder/SUMMARY.md, it silently breaks?)

kratsg avatar Mar 01 '23 22:03 kratsg