GitHub - README.md Windows editor?

Question

I have lots of libs on GitHub and would like to write README.md for all of them. Im doing this by writing into README.md on my local repo, and then pushing it to github, and there I can see changes.

Is there any other way of doing this? Is there some Windows editor so I can write README.md and all the tags on local PC and see who would README.md output look like?

Thanks!

Loisloise

Answer 1

I prefer MarkdownPad. It provides you with a nice preview window on side of the actual markdown code:

Note that if you want to make it compliant with Github's own markdown syntax, you need to additionally install markdownpad-github.

Edit: MarkdownPad 2 Pro has announced support for Github flavored markdown: http://markdownpad.com/news/2013/introducing-markdownpad-2/

Muckraker

Looks awesome. Can it recognize syntax like github can, using '''''php some code'''''? – Loisloise

Oh dang. Seems like you are still gonna miss some features like syntax highlighting: github.com/nicolahery/markdownpad-github. But I gotta say, I've been a happy user nonetheless. – Muckraker

Hey - developer of MarkdownPad here. Just wanted to let you know that GitHub syntax highlighting will be available in MarkdownPad this week :) – Raymond

@Muckraker Thanks for posting the link to the announcement! :) – Raymond

Sadly, this project seems to have died. Latest version is of 2015 and won't run on Windows 10 – Guillaume

A vivid alternative might be ghostwriter. – Guillaume

Answer 2

I'm late to the party, but VS Code has a pretty nice built-in markdown editor and live preview. You can just snap the preview tab on the right (or left if you're that kind of person) to see your changes as you make them.

Coitus

Answer 3

I would add MaNo to the list of options on WindowsTM. Very lightweight at 270k. Not wysiwig, but F5 to generate HTML and load into default viewer. MaNo Markdown notepad editor

Command line options to generate html file, load in browser and quit - use MaNo as a Markdown viewer.

Kind Regards Gavin Holt

Meryl