search

backstage / mkdocs-monorepo-plugin

✚ Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
https://backstage.github.io/mkdocs-monorepo-plugin/
Apache License 2.0
314 stars 75 forks source link

Question about navigation #65

Open shinji62 opened 2 years ago

shinji62 commented 2 years ago

Hello there,

First thanks for this incredibly useful plugin, I have a question related to navigation

1- Can we setup the navigations tabs by subdirectory ? if yes how ?

Thanks cc @iamEAP @wilhelmer

wilhelmer commented 2 years ago

Not sure what you mean, do you need this to be done automatically? E.g., you create subdir1, subdir2, and subdir3, and they automatically appear as navigation tabs? I don't think that's possible.

However, you can easily define that manually in your mkdocs.yml:

nav:
    - Home:
        - Tab 1: '!include ./subdir1/mkdocs.yml'
        - Tab 2: '!include ./subdir2/mkdocs.yml'
iamEAP commented 2 years ago

This proposal is kind of close: #67 ...But it's more about the next layer down than the top-level navigation.

I'm not aware of a way to auto-generate an entire navigation by directory; I'd echo Lars' response.