Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How can I test what my readme.md file will look like before committing to github?

I am writing a readme for my github project in the .md format. Is there a way can I test what my readme.md file will look like before committing to github?

like image 569
Usman Ismail Avatar asked Feb 17 '12 15:02

Usman Ismail


People also ask

How do I preview a .md file?

Tip: You can also right-click on the editor Tab and select Open Preview (Ctrl+Shift+V) or use the Command Palette (Ctrl+Shift+P) to run the Markdown: Open Preview to the Side command (Ctrl+K V).


2 Answers

Many ways: If you're on a Mac, use Mou.

If you want to test in a browser, you could try StackEdit, as pointed out by @Aaron or Dillinger since Notepag seems to be down now. Personally I use Dillinger since it just works and saves all my documents in my browser's local database.

like image 64
three Avatar answered Sep 28 '22 12:09

three


Atom works nicely out of the box - just open the Markdown file and hit Ctrl+Shift+M to toggle the Markdown preview panel next to it. It handles HTML and images also.

Atom screenshot

like image 29
Brian Burns Avatar answered Sep 28 '22 10:09

Brian Burns