benbalter/jekyll-readme-index

README.* should serve as index even when it has frontmatter

Closed this issue · 6 comments

jldec commented

It's confusing for users that when they add frontmatter to a readme (e.g. to specify a layout) it stops generating index.html, even if they don't have any other files producing an index.html.

Would it make sense to adjust this logic so that README's always work like index files unless there already is another index file, or they explicitly set a different permalink?

That makes sense. It'd be a matter of adding || site.pages.find { |page| page.relative_path =~ README_REGEX } to https://github.com/benbalter/jekyll-readme-index/blob/master/lib/jekyll-readme-index/generator.rb#L25.

👍 I could use this also.

If anyone is interested in submitting a pull request for this, I'd be more than glad to review it. There's some pseudo code above which may help.

stale commented

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.

stale commented

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.

Hello,
Is there any support for README.adoc files?