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

github markdown github-flavored-markdown
Usman Ismail picture Usman Ismail · Feb 17, 2012 · Viewed 133k times · Source

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?

Answer

three picture three · Feb 17, 2012

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.

Related questions

How to add images to README.md on GitHub?

Recently I joined GitHub. I hosted some projects there. I need to include some images in my README File. I don't know how to do that. I searched about this, but all I got was some links which tell me …

Read More
GitHub relative link in Markdown file

Is there a way to create a URL anchor, <a>, link from within a Markdown file, to another file within the same repository and branch (aka a link relative to the current branch)? For example, in the master …

Read More
Is there a command line utility for rendering GitHub flavored Markdown?

I'm wondering if there is a command line utility for taking a GitHub flavored Markdown file and rendering it to HTML. I'm using a GitHub wiki to create website content. I've cloned the repository on my server and would then …

Read More