link a file at the root of the project

[JOduMonT]

Hi everyone;

I tried to make a file which is at the root of my project into mkdocs
let's me try to explain

mkdocs render everything inside ./docs/*
my file is at the root level which like ./norendering.md instead of ./docs/rendering.md

an example I found is https://github.com/mkdocs/mkdocs/blob/master/CONTRIBUTING.md what if I want this file appear inside the website like this one https://github.com/mkdocs/mkdocs/blob/master/docs/index.md

regards!

Jonathan

ps: if rendering is not the appropriate words tell me how to speak python/jinga/mkdocs :)

[waylan]

This appears to be related to #1134 and #1279. As there is currently no open issue for this, I'll leave this open so we don't forget about it.

[JOduMonT]

wow I just saw (34ef3ca#diff-55f7e7bab4ecafd524c20778d6920fdaR43)

I can't wait to test it :)

Thanks!

[waylan]

@JOduMonT a beta has been released. Please do test it out. To install do:

pip install --upgrade mkdocs=1.0b1

[cruisercoder]

I see how I can symlink to a README.md above docs at the root of my repo, but this doesn't work when that file has links to other markdown documents relative to the README.md at the root of the tree (not the docs dir). Is there a solution for this?

[deltahedge1]

after sometime I found some extensions which did the trick, using pymdown-extensions and specifically the snippets ext you can now include files like README.md and changelog.md from your root directory.

https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

[ssbarnea]

@deltahedge1 Sadly this approach does not work with mkdocs monorepos and probably neither with simple inclusion.