netzpirat/codo — Issue #12: [Feature] Respect default Github pages _*.html behavior
Author: inossidabile
Created: 2012-02-19 17:09:42+00:00
State: open

Github pages are likely the place where a lot of project will store their API docs. However by default Github will ignore the filenames that start from underscore. To fix this behavior you can put ".nojekyll" file to your root. It's not very clear for most of people though.

To respect them I think we should rename the file where Codo keeps elements index (it's _index.html) now. Or maybe we can put .nojekyll to the root since it's quite a fantastic case to use the same root for jekyll.

I'm not really sure if we should care about it at all nor I'm sure which is more correct way to solve this that's why I didn't do a pull request. But I trust that if we can let people avoid some confusing situations we should do it.