search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
87 stars 64 forks source link

Add support for literate-nav in techdocs #51

Closed punkle closed 1 year ago

punkle commented 2 years ago

It would be great if liberate-nav was supported as it allows more dynamic mapping of mkdocs links.

andrewthauer commented 2 years ago

Interesting. Haven't seen that one. However, we have been using awesome-pages in a custom container for quite a while. It seems to cover a similar use case. At first glance, I may prefer the approach with liberate-nav over awesome-pages. They claim it supplants it.

This approach for distributing the nav allows us to avoid having an mkdocs.yaml file entirely, which we generate dynamically. Something we are considering contributing at some point.

maayanshem commented 2 years ago

Hey, I asked for it, but I really think I'll just generate the mkdocs.yml dynamically. It makes sense because I intend to use like 1% of literate-nav capabilities.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.