Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I convert README.md to Github-styled HTML?

I have a README.md file (describing a Node app) that I need to convert to a self-contained Github-styled README.html.

Note that this is not the same as finding an HTML converter for Github-flavored markdown. The precise style is important, and so is the self-contained part. (This is how my question is different from this one).

It can be an npm package or an online converter or perhaps some obscure (to me) Github feature allowing to view README.md full-screen, without the Github toolbar and such.

I can live with a Ruby gem or another language/platform if I have to. It needs to be simple, because I modify this README.md often.

like image 398
Irina Rapoport Avatar asked Oct 19 '22 07:10

Irina Rapoport


1 Answers

There is a plugin for sublime text 2 that will do this for you, it is pretty darn accurate

https://github.com/revolunet/sublimetext-markdown-preview

There is also a github markdown API which you might be interested in: https://developer.github.com/v3/markdown/

And the CSS: https://github.com/sindresorhus/github-markdown-css

like image 198
edhurtig Avatar answered Oct 21 '22 09:10

edhurtig