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

link a file at the root of the project #1373

jodumont opened this Issue Jan 7, 2018 · 3 comments


2 participants

jodumont commented Jan 7, 2018

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 ./ instead of ./docs/

an example I found is what if I want this file appear inside the website like this one



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


This comment has been minimized.


waylan commented Jan 7, 2018

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.

@waylan waylan added the Enhancement label Jan 17, 2018

@waylan waylan added this to the 1.0.0 milestone Jan 17, 2018

@waylan waylan added this to To do in Pages Refactor Feb 5, 2018

@waylan waylan moved this from To do to In progress in Pages Refactor Jun 7, 2018

@waylan waylan referenced this issue Jun 8, 2018


Pages Refactor #1504

@waylan waylan closed this in 34ef3ca Jun 28, 2018

Pages Refactor automation moved this from In progress to Done Jun 28, 2018


This comment has been minimized.

jodumont commented Jul 26, 2018

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

I can't wait to test it :)



This comment has been minimized.


waylan commented Jul 26, 2018

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

pip install --upgrade mkdocs=1.0b1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment