Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unable to use includes #92

Open
ssbarnea opened this issue Jan 18, 2023 · 3 comments
Open

Unable to use includes #92

ssbarnea opened this issue Jan 18, 2023 · 3 comments

Comments

@ssbarnea
Copy link

ssbarnea commented Jan 18, 2023

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: cmacmackin/markdown-include#41

@ssbarnea
Copy link
Author

ssbarnea commented Jan 24, 2023

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
Copy link

Hi, are there any updates on this issue?

@bih bih closed this as completed Jan 4, 2024
@bih bih reopened this Jan 4, 2024
@hyp0th3rmi4
Copy link

Hello, is there any update on this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants