🌱 This post is in the growth phase. It may still be
useful as it grows up.
This document describes markdown in terms of Prettier defaults. If you don’t use prettier, find syntax alternatives on Daring Fireball.
Many examples have been used from the Daring Firebal documentation.
GitHub Flavored Markdown (GFM)
Most code environments use custom Markdown parser called GitHub Flavored Markdown (GFM).
The most notable difference is how GFM handles code blocks — using a code fence.
(GFM) where GFM-specific syntax is demonstrated.
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
Blockquotes support markdown
- This is the first list item.
- This is the second list item.
Here’s some example code:
Examples from Daring Fireball
Ordered lists are alway consecutive.
The only number that makes a difference is first. Anything other than
1, sets the
start value on the
Lists of paragraphs
Lists with markdown
Code block (GFM)
Nested markdown code
Add more backticks for infinite nesting.
This syntax can often be hard to remember.
Someone recommended thinking of it as calling a named function with the url. It’s stuck with me ever since.
Automatic entity encoded email
This last part more interesting than anything else. Surely bots decode this.
- NOT case sensetive.
- CAN be defined anywhere in the document.
See Link for more reference style options.
Markdown supports HTML and, therefore, details.
However, in order to put markdowndown inside of a summary, there needs to be additional line-breaks between HTML elements and markdown blocks.
Markdown can go in here if you leave extra line breaks.
markdown-it-container can be used to create definition lists.