6

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.

Community
  • 1
  • 1
Irina Rapoport
  • 334
  • 3
  • 10
  • Possible duplicate of [Is there a command line utility for rendering GitHub flavored Markdown?](http://stackoverflow.com/questions/7694887/is-there-a-command-line-utility-for-rendering-github-flavored-markdown) – OneCricketeer Jun 09 '16 at 03:51
  • I saw that one. I have not checked every solution offered, but those I did check only parse github-flavored markdown, but don't apply github styling. – Irina Rapoport Jun 09 '16 at 04:02
  • Is styling really that important? If one of those tools generates HTML, then I would imagine any CSS style could be applied – OneCricketeer Jun 09 '16 at 04:03
  • Not always. For instance, most HTML generators I see don't support language-specific index highlighting. – Irina Rapoport Jun 09 '16 at 04:05

1 Answers1

3

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

edhurtig
  • 2,331
  • 1
  • 25
  • 26