CommonMark Ready Reference
::: by V. Subhash :::
Tutorial and hacks to create documents using the new MarkDown standard
MarkDown is an easy human-readable text format that can serve as a strong base for exporting to other document formats such as HTML, ODF, DOC/DOCX, PDF and ebook (EPUB, MOBI…). It is a great tool for authors, technical writers and content developers to create books, manuals, web pages and other rich-text content.
CommonMark is a new well-formed standard for the old MarkDown spec. CommonMark was one of the reasons I was able to write and design 21 books in one year. Incidentally, this is the first-ever book on CommonMark. You will be buying a piece of history! This book's covers are designed like a quick reference card - a free PDF download is also available for anyone.
- Target: Authors, web designers, content/technical writers
- First published in: June 2020
- Pages: 60 (42 pages with real content)
| Format | Store | Price |
|---|---|---|
| Paperback | Amazon | $7.70 |
| Ebook (print replica) | Amazon | $6 |
About CommonMark
Despite its phenomenal success online and widespread adoption even beyond the Internet, one problem that continued to bug Markdown was the lack of a proper standard. Today, CommonMark (https://www.CommonMark.org) is replacing Markdown as the de facto standard for low-markup text. CommonMark hit the ground with a well-defined standard from Day 1 and is set to replace and overtake MarkDown. StackOverFlow.com and other sites have already adopted it. CommonMark is MarkDown done right. It is highly compatible with the original MarkDown and resolves most of its ambiguities. The book CommonMark Ready Reference provides a tutorial, hacks collection and a ready reference for the new standard.
The Book
CommonMark Ready Reference is for those who need a desk-side reference and for those who would like to learn MarkDown/CommonMark at leisure. If you are on a computer, there will be plenty of free online alternatives available including the official documentation.
This book is based on 0.29 version of CommonMark. It may be superseded by newer versions. Whatever the case, the official documentation that is directly applicable to the version of Markdown/CommonMark that you use in production will always have more relevance.
Table of contents
- MarkDown and CommonMark
- Starting with CommonMark
- Text
- Images
- Links
- Horizontal Rule
- Code blocks
- Headings
- Blockquotes
- Lists
- HTML blocks
- Exporting to other document formats
The Executables
Anyone can build CommonMark from its source code available at https://github.com/commonmark/cmark. I built my CommonMark executables (for Linux and Windows) using version 0.29. You can use them at your own risk.
These executables were built on a 9-year-old OS. While they are fully functional, I would like you to build them on your computer to avoid compiler bugs and for maximum safety.
Free Printable CommonMark/MarkDown Quick Reference Card
Inside the book, there is a b/w quick reference card. I have provided it as a free download. You can print as many copies as you want.
Subscribe to my newsletter
The details are mentioned in my author newsletter blogpost. Full/sample PDF ebooks of several books are listed in it. You do not have to subscribe to download them. However, if you do subscribe, you get a FREE 200-puzzle combined ebook version of my World of Word Ladders books.
Video Demo
This video shows how the back cover looks. (The reference card on the paperback is also NOT lopsided. The screenshot is an early draft. I am not going to fix it in the video.) The book is also not as big. I doubt if it even has a spine. I cannot get the paperback ordered as India is under lockdown.
