Fall back to README.md when docs/index.md not found.
dtinth opened this issue · comments
This can be especially useful to those who do README driven development.
cujojs/when is an example of a project that uses README.md as an index for documentation, while putting other docs inside docs directory.
To implement this, some care must be taken in resolving relative links: links to images should be relative to the project's root, whereas links to pages inside the docs directory should have the docs component stripped out, and maybe, links to files outside the docs directory just link to the blob page on GitHub.
Right, this would be nice but it seems it would take some thought to do properly and elegantly. Looking forward to any PRs.