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

Respect Gitlinks per Attached Repository #46

Open GAS85 opened 3 years ago

GAS85 commented 3 years ago

Hello dear community, in e.g. mkdocs-material there is nice feature: https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#adding-a-git-repository

By simple config in yaml file:

repo_name: Trolololo
repo_url: https://somehost.com/Trololo
edit_uri: "edit/master/docs/"

will enable this: grafik By clicking you are jumping into the Repositroy to exact file.

When I use monorepo no links will be provided.

Please respect config per attached repository.

realandersn commented 3 years ago

Hi! This is a great feature, but is a bit broken with this plugin at the moment. There are issues open for this problem, see #2 and #45.

GAS85 commented 1 year ago

Seems partly works now. I can see Edit Button, but Links are broken - there is a site_name: Value taken from the merged mkdocs.yml. I need to apply workaround to html directly what is not really good way of doing this (as per your README example):

find v1/ -name '*.html' -exec sed -i 's/\/versions\/v1//' {} \;
find v2/ -name '*.html' -exec sed -i 's/\/versions\/v2//' {} \;