markdown-include icon indicating copy to clipboard operation
markdown-include copied to clipboard

Incompatible with

Open ssbarnea opened this issue 2 years ago • 2 comments

It seems that all includes used in child projects fail to render when using mkdocs-multirepo-plugin which is by far the most popular solution for combining multiple mkdocs sites into a single one.

What I observed is that the include renders as empty in this case, probably because it fails to find the file to include.

ssbarnea avatar Jan 23 '23 15:01 ssbarnea

If that plugin is changing paths so that the relative paths are wrong in your markdown files, there's probably not much we can do in this plugin. I think you would either need to fix the paths to work in the monorepo, or write a compatibility plugin that can rewrite the paths automatically for you.

I'm afraid I won't have time to investigate this myself, but if you do come up with a solution for markdown-include, I'd be happy to review and merge it.

ZedThree avatar Jan 24 '23 09:01 ZedThree

Thanks for the quick feedback. For the moment I decided to avoid any inclusions on any mkdocs based project. That seems to be the only safe way to keep ability to build composed sites (multiple projects). Other include methods had the same issue, so the issue is not unique to this plugin.

ssbarnea avatar Jan 24 '23 09:01 ssbarnea