mkdocs-merge icon indicating copy to clipboard operation
mkdocs-merge copied to clipboard

remove nav entry and make it optional as it is not required

Open hsjobeki opened this issue 3 years ago • 5 comments

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?

hsjobeki avatar Jun 01 '22 06:06 hsjobeki

I'd like to suggest some more improvements from my side, that I will pretty likely make in a fork of your code.

  1. 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.
  2. 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?

hsjobeki avatar Jun 01 '22 06:06 hsjobeki

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 😊

ovasquez avatar Jun 10 '22 19:06 ovasquez

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?

comatory avatar Jul 17 '24 11:07 comatory