jekyll-readme-index
jekyll-readme-index copied to clipboard
Add support for overriding the README-recognizing regex
This can be used to configure the plugin to use one of the alternative READMEs GitHub supports or even any other custom file!
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
If you put your README file in your repository's hidden
.github,root, ordocsdirectory, GitHub will recognize and automatically surface your README to repository visitors.
If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the
.githubdirectory, then the repository'srootdirectory, and finally thedocsdirectory.
Closes #38