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
316 stars 74 forks source link

Internal Markdown links in included folder not converted to HTML when pointing outside included folder #10

Open ryandaugherty opened 4 years ago

ryandaugherty commented 4 years ago

Your tool is awesome, and thanks for open sourcing it! It solves a very common problem.

I'm using:

mkdocs 1.0.4 mkdocs-monorepo-plugin 0.4.3

I have a pretty basic setup:

In the secondary docs folder, I have a page where I am trying to create a Markdown link to a page in the primary docs folder. I do so with something like: [MyLink](MyLink.md) I'm assuming it is possible to get back to the root this way (I have also tried /MyLink.md).

However, the resulting link is not correctly being converted to HTML when the site is built. It comes out to be: <a href="MyLink.md">MyLink</a>

With the .md extension, the link is then not found. For included folders, it seems like the build is not aware when internal links are pointing outside of that included folder. The only way to get around this is using an HTML link.

Thanks much!

prcr commented 3 years ago

See my reply here https://github.com/backstage/mkdocs-monorepo-plugin/issues/25#issuecomment-744086700 for a solution using relative links that has been working for me.