backstage / backstage/mkdocs-monorepo-plugin

Support dynamic navigation in main and subfolder mkdocs.yml files

Open
#6 9 comments 6 reactions 0 assignees View on GitHub
wontfix
Dominant language
Python
Stars
400
Forks
80
PR merge metrics
No merged PRs in 30d

Description

While this plugin is awesome for monorepos, it does introduce the burden of having to define the complete navigation structure manually.

It would be great if functionality similar to [mkdocs-awesome-pages-plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) could be included. The point would be to allow navigation structures to be partially defined (i.e. to add `!include` directives) yet still end up with a complete navigation tree.

As for why? Well, it would allow team members to add new docs without having to also update and maintain the `mkdocs.yml` file.

Contributor guide

Open the contributing guide

Research direction

Start by examining how the plugin currently processes the main and subfolder mkdocs.yml files. Compare the requested partial navigation and !include behavior with mkdocs-awesome-pages-plugin. Done means teams can add documentation without manually maintaining a complete navigation tree.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.