mkdocs-merge
mkdocs-merge copied to clipboard
remove nav entry and make it optional as it is not required
Hey Oscar,
I just found your tool, as it is currently the only one I found so far for combining many docs into a single source. Still, you built a pretty awesome base that could be extended further. ;)
I found, that providing the "nav" entry in mkdocs.yaml is pretty useless as mkdocs will discover all the files by itself. I am a little new to this topic. but am I wrong?
I'd like to suggest some more improvements from my side, that I will pretty likely make in a fork of your code.
- Don't overwrite the Master, put the output in a new directory. People might want to re-run your tool. -> eg.g build/ should be re-created on each run.
- If you have multiple documentations and merge them into one, you might also have different git URLs in their yaml files. How do you plan to handle that?
Hey @hsjobeki, thanks for the suggestions, it's been quite a while since I updated this script but your suggestions make sense. I'll add them as enhancement requests. I don't have a specific timeline for the updates, but I expect to make progress on this during the next month 😊
I would love to have this. For me it even fails on missing nav key which IMHO is not required (I use mkdocs-material).
I would also like have support for build directory, like build/, maybe via site_url configuration?