Readme on GitHub is not parsed as markdown

rse / componentjs

ComponentJS -- Powerful run-time Component System for structuring HTML5-based Rich Clients

http://componentjs.com/

Other

85 stars 13 forks source link

Readme on GitHub is not parsed as markdown #21

Closed Eminenz closed 11 years ago

Eminenz commented 11 years ago

Since GitHub is able to parse different readme flavours (with markdown probably being the most popular), they only parse it with a parser matching the file ending. Therefore it would be good to rename README to README.md to have GitHub parse the Readme into markup.

rse commented 11 years ago

That's right: it isn't actually Markdown what is in the files README, LICENSE and CHANGES. I know, it might look like Markdown, but that is a coincidence: Markdown syntax resembles what Unix hackers used since decades to markup their text files. So, I don't want to change this to true Markdown now. At least we then also should change LICENSE and CHANGES. But those files by convention have no .md extension, too. So, I decided to not take over this enhancement suggestion. Sorry.