ovasquez / mkdocs-merge

Merge the source of multiple MkDocs sites into a single one
https://ovasquez.github.io/mkdocs-merge/
MIT License
22 stars 6 forks source link

Add support for section index pages #17

Closed Acerinth closed 1 year ago

Acerinth commented 1 year ago

Hey there!

Firstly, thank you so much for this amazing tool!

In our company, we use it in combo with MkDocs Material. Not sure about original MkDocs, but in this version, there is an option to set index pages for sections. To get a better understanding, please take a look at feature description.

It's very simple, and what it means, is that basically you may now have a nav entry in mkdocs.yml that looks like this:

nav:
  - Home: index.md
  - Section:
    - section/index.md                             #   <--- this right here is new!
    - Page 1: section/page-1.md
    ...
    - Page n: section/page-n.md

Those kind of entries are currently not supported and result in "Error merging the "nav" entry in the site: xxxx".

I've taken a quick look at the code - to me seems like a new elif in recursive function update_navs should be added where nav can be instance of str, or sth like that.

I hope you'll have a bit of time to consider this.

Thanks!