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

Unable to use includes #92

Open ssbarnea opened 1 year ago

ssbarnea commented 1 year ago

On child projects we use includes for files that need to be at project root, like README.md or CHANGELOG.md and this is achieved using

<!-- docs/changelog.md -->
{!../CHANGELOG.md!}
# child mkdocs.yml file
plugins:
  - markdown_include.include:
      base_path: docs

While this works when building docs of each child-site, it does not work with monorepo plugin.

I mention that our initial attempt was to use symlinks from docs/ to parent but that does not work with mkdocs either, being forced to use the include method. Also creating symlinks from root to docs/ folder does not work because github does not display these markdown files correctly.

Related: https://github.com/cmacmackin/markdown-include/issues/41

ssbarnea commented 1 year ago

Also pymdown-snippets are not working at all with includes because the relative paths are now computed against the new parent mkdocs.yml file, so the included file is never found.

Is there any inclusion markdown extension that really works with monorepo plugin?

jorgegomezcq commented 7 months ago

Hi, are there any updates on this issue?