Skip to content

Instantly share code, notes, and snippets.

@johnmcfarlane
Last active May 12, 2017 19:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save johnmcfarlane/aec9d1c55d25bbbc086469c0c897b580 to your computer and use it in GitHub Desktop.
Save johnmcfarlane/aec9d1c55d25bbbc086469c0c897b580 to your computer and use it in GitHub Desktop.
A very quick demonstration of commonmark

A quick vote for commonmark:

  • it's very easy to read and write - even in as raw text;
  • it's well supported by GitHub;
  • it does 90% of what you need to write technical documentation;
  • it allows you to casually drop snippets of HTML/JSON in for the other 10% and
  • there are plenty of tools for converting it to HTML and other formats (see Pandoc and cmark).

In fact the above rant is commonmark! https://gist.github.com/johnmcfarlane/aec9d1c55d25bbbc086469c0c897b580

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment