Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Recognize README.md as well as index.md for index files #39

Open
ryan-blunden opened this issue Apr 13, 2020 · 0 comments
Open

Recognize README.md as well as index.md for index files #39

ryan-blunden opened this issue Apr 13, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@ryan-blunden
Copy link
Contributor

ryan-blunden commented Apr 13, 2020 •
edited

Dociste shouldn't force developers to use index.md instead of README.md files. READMD.md files are advantageous because GitHub, for example, will render the markdown when viewing files at the directory level if a README.md file exists.

Having docsite support both README.md and index.md files would improve user experience when browsing docs code on a code host.
@ryan-blunden ryan-blunden added the enhancement New feature or request label Apr 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ryan-blunden