Feature Request: allow using repo root README.md for /docs site
Closed this issue · 8 comments
Is your feature request related to a problem? Please describe the problem you're trying to solve.
GitHub now allows a website to be generated from a subdirectory of the master branch.
This means you end up with a directory structure like:
root
- /README.md
- /docs
- /... other doc files
However, as the README.md file is not in the website directory, this plugin doesn't work.
Describe the solution you'd like
If at all possible, I'd like the site's index.html file to be generated from the README.md in the project root.
I'd appreciate your consideration for this feature request.
Describe alternatives you've considered
Using Liquid {% include_relative ../README.md %} won't work as that syntax strictly forbids going up the directory tree.
@jrfnl have you tried using a symlink, either from the root to docs/ or from docs/ to the root?
@benbalter Thanks for responding.
have you tried using a symlink, either from the root to docs/ or from docs/ to the root?
No, I haven't. I'm a Windows user, so never work with symlinks and wouldn't even know how to set that up.
Any insights appreciated.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
Just leaving a comment to prevent the issue from being closed as the feature request still stands.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This is a good need, is there a way to solve it?
@jrfnl move README.md to docs/ dir, it's can be used for me.
about github readme