search

lukasgeiter / mkdocs-awesome-pages-plugin

An MkDocs plugin that simplifies configuring page titles and their order
MIT License
453 stars 35 forks source link

Configuration to tell nav to include non-specified entries without and `...` rest option #38

Open mrmanc opened 3 years ago

mrmanc commented 3 years ago

Love the plugin—it was probably the killer feature that persuaded us to migrate our docs to mkdocs from Jekyll, as it was so simple for a contributor to add a page to the navigation.

I recently migrated the pages files to replace arrange: with nav: as I spotted it was a deprecated syntax but failed to spot the change in functionality 🤦🏻‍♂️. I’ve just worked out (after spotting #20) why some pages weren’t showing, and now understand how to fix that.

However, I’m worried that our contributors won’t understand that when they add a page to a folder with a .pages file (or when they create a .pages file) that they need to specify explicitly where unmentioned items should sit. They aren’t familiar with how mkdocs and it’s plugins work, as we encourage all engineers across the organisation to contribute to the site.

We never really want to hide pages in the navigation, and I’m conscious that the next major release will remove arrange: support, so I wondered if it would be possible to add plugin configuration to be able to disable this part of the nav: functionality? I think it will save people some head-scratching in the future for sites like ours.

Thanks!

lukasgeiter commented 3 years ago

I'm glad to hear you like the plugin. I can see how this behavior might cause users to accidentally hide pages.
Having an option for it makes sense and should be fairly straightforward to implement. I'll definitely make sure to have a solution for your case before removing arrange completely.

mrmanc commented 3 years ago

Amazing, thanks so much 😃