search

docsxx / docs.github.com

Generated documentation for Github projects
http://docs.github.com
5 stars 0 forks source link

inserts <tt> tags into markdown readme #1

Open langalex opened 15 years ago

langalex commented 15 years ago

the readme.md file at http://github.com/langalex/couch_potato/ contains some ruby code examples. on the docs page (http://docs.github.com/langalex/couch_potato/blob/030d5d7118330ef08559faade8492361a0765b27/) some curly braces and pipes are replaced with tags

zapnap commented 15 years ago

I believe that this is because yardoc is trying to translate the md file as an rdoc-formatted file, and in rdoc curly braces are used for links :(. We need to do explicit conversion on textile and markdown-styled READMEs in the rdocinfo doc builder; there's an open ticket for this item at http://github.com/zapnap/rdocinfo/issues -- we'll get to it asap