Last Updated: December 26, 2018
· magnetikonline

Preview GitHub Markdown documents locally

I have been writing a tonne of Markdown documents for GitHub repositories lately ('s and the like) and having to play the dance of git push constantly due to rendering issues/typos in these files is annoying and blots my commit logs.

After discovering that GitHub offer a great Markdown -> HTML API endpoint, this PHP web-app/utility seemed like a good idea. Will render your Markdown files locally on your development machine, using GitHub's rendering routines (including source code syntax highlighting) and then displays them using the same CSS/styling that will appear on GitHub itself.

Suggestions/improvements welcome of course :)