Markdown features
Table of contents
Markdown Cheat Sheet
Thanks for visiting The Markdown Guide!
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.
Basic Syntax
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
Heading
H1
H2
H3
Bold
bold text
Italic
italicized text
Blockquote
blockquote
Ordered List
- First item
- Second item
- Third item
Unordered List
- First item
- Second item
- Third item
Code
code
Horizontal Rule
Link
Image
Extended Syntax
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
Table
Syntax | Description |
---|---|
Header | Title |
Paragraph | Text |
Fenced Code Block
{"firstName": "John","lastName": "Smith","age": 25}
Footnote
Here's a sentence with a footnote. 1
Heading ID
My Great Heading {#custom-id}
Definition List
term : definition
Strikethrough
The world is flat.
Task List
- Write the press release
- Update the website
- Contact the media
Theme Features
This theme adds a few additional features to standard markdown.
Highlighting lines in code blocks
To highlight lines, wrap line with this comment before: // highlight-start
and this after // highlight-end
. Ensure that these comments are not indented.
.grid {display: grid;grid-gap: 30px;grid-template-columns: repeat(auto-fill, 112px);/* or this */grid-template-columns: repeat(auto-fill, minmax(112px, 1fr));}
Emoji short codes
Like this: 😂 🍆
Like this: :joy: :eggplant:
Details/Summary
Open example
Tada! 🎉
<details><summary>Open example</summary>Tada! :tada:</details>
Tables
Tables are responsive by default. If you need to limit line length for a cell, add a <br/>
tag to break the lines.
Tables | Are | Cool |
---|---|---|
This is a row | with some | content |
This is another row | with a lot more content. Nullam netus eu fringilla turpis parturient dignissim | Velit ut mauris penatibus turpis commodo consectetur |
- This is the footnote.↩