Open hjoukl opened 2 years ago
It took me more than an hour of debugging to discover the same bug. In my case I symlink the index.md
to ../README.md
.
mkdocs has no problem build and service the docs, only multirepo fails.
It work mentioning that I cannot reverse the files as github UI does not recognize README.md files in repository root.
Hi,
nice plugin!
Suppose you have a repo
myrepo
with toplevel LICENSE and AUTHORS documents that are symlinked from the docs folder, to avoid duplication but use this info in the mkdocs-generated documentation:This works with
mkdocs serve|build
when the repo is used "standalone".However, if you want such a repo to be imported with multirepo-plugin:
... the symlinks get broken in the
temp_dir
sparse checkout:This is due to the way the docs folders contents are put into
temp_dir/documentation/myrepo
directly, which changes the nesting level. This makes the symlinks invalid.Making the links the other way round (e.g. `AUTHORS.md --> docs/about/AUTHORS.md) isn't attractive since you lose the ability to directly render the markdown files in the VCS-GUI (at least in bitbucket, in my case), since the actual git repository content of such symlinks is the path to the symlinked file.
And you also can't just reference a markdown file in
nav: ...
outside of thedocs_dir
.Workaround: Duplicate files. Avoid links crossing
docs_dir
.Best regards, Holger