Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

GitHub - README.md Windows editor?

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!

like image 785
otporan Avatar asked Oct 17 '12 10:10

otporan


People also ask

Which editor GitHub uses for rendering readme files?

Retext (github wiki: retext-project/retext , github: retext-project/retext ) - ReText is a simple but powerful editor for markdown and reStructuredText markup languages. ReText is written in Python language and works on Linux and other POSIX-compatible platforms.

How do I edit a .md file?

Open the project editor and make sure that the README.md file is selected in the file view on the left. At the top of the editing pane, click the EDIT MARKDOWN button to reveal edit mode for the file. Now you can start typing directly in the file.


1 Answers

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

enter image description here

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/

like image 107
jsalonen Avatar answered Oct 12 '22 23:10

jsalonen