search

github / markup

Determines which markup library to use to render a content file (e.g. README) on GitHub
MIT License
5.86k stars 3.39k forks source link

Render readme.html through the pipeline instead of as html source? #461

Closed gwk closed 9 years ago

gwk commented 9 years ago

I recently tried using a readme.html file (generated from an experimental markup format) in a project, and found that it got displayed on the project page as source. It makes sense to me that in general html files in a project should be displayed as source, but I wonder if anyone has ever considered making the readme a special case? I'm curious how hard/problematic this would be. Despite my general aversion to special casing things, it seems justified; after all, the readme is a special case already :)

bkeepers commented 9 years ago

Hi @gwk, thanks for the suggestion. I actually think it's a really interesting idea. Since it's not a very common use case, it probably won't be high on our priorities, but we'll keep it in mind.

Either way, a change to this library can't implement it, so I'm going to close this issue.

gwk commented 9 years ago

@bkeepers ok, thanks. could you point me to the github lib that would be responsible for this, or is that not published?

bkeepers commented 9 years ago

@gwk it's part of the core of the application logic in GitHub, so unfortunately I can't point you to the code.