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
313 stars 75 forks source link

Question: Is it possible to point to multiple repo_url's? #88

Open SteveRosam opened 1 year ago

SteveRosam commented 1 year ago

Mkdocs allows you to point to a repo_url, linking the rendered doc directly to the github file. But with mono repo we have many github repos, is there any way to allow the linking to work?

whiskeysierra commented 1 year ago

See #2, #45 and #46.

jdoiro3 commented 1 year ago

mkdocs-multirepo-plugin lets you import multiple repos with docs into one site and handles generating the correct edit url links for the pages.

srosam commented 1 year ago

See #2, #45 and #46.

thanks. got it working now. (mostly)

srosam commented 1 year ago

mkdocs-multirepo-plugin lets you import multiple repos with docs into one site and handles generating the correct edit url links for the pages.

yeah I saw that one but had some issue. It wasn't generating the pages for repos it pulled down

jdoiro3 commented 1 year ago

mkdocs-multirepo-plugin lets you import multiple repos with docs into one site and handles generating the correct edit url links for the pages.

yeah I saw that one but had some issue. It wasn't generating the pages for repos it pulled down

@srosam, feel free to open an issue. I'd like to fix whatever issue you encountered for future users.

rafalkrupinski commented 2 weeks ago

I was luckier with either using symlinks (locally) or checking out (github action) the other repos and pretending it's a monorepo.