A reference page for the Markdown markup language. This is not meant to be an in-depth documentation. Syntaxes for GitHub Flavored Markdown, Markdown Extra and MultiMarkdown are also included.
Action | Syntax | Output |
---|---|---|
Bold |
**Bold text** __Bold text__ | Bold text |
Italic |
*Italicized text* _Italicized text_ | Italicized text |
Heading 1 (2.5rem) |
# Heading 1 Heading 1 ========= |
Heading 1 |
Heading 2 (2rem) |
## Heading 2 Heading 2 --------- |
Heading 2 |
Heading 3 (1.75rem) | ### Heading 3 |
Heading 3 |
Heading 4 (1.5 rem) | #### Heading 4 |
Heading 4 |
Heading 5 (1.25rem) | ##### Heading 5 |
Heading 5 |
Heading 6 (1rem) | ###### Heading 6 |
Heading 6 |
Link | [GitHub's website](https://github.com) | GitHub's website |
Image | ![Shapes](https://i.ibb.co/SVFjNpN/shapes.png) | |
Numeric (ordered) list |
1. Apples 2. Bananas 1. Yellow 2. Red 3. Oranges 4. Strawberries |
|
Bulleted (unordered) list |
- Math - Algebra 2 - Precalculus + Physics * English - Art |
|
Code | `for (let x in cars["acura"])` |
for (let x in cars["acura"])
|
Code block |
``` let toolbox = { color: 'red', toolCount: 5, } if (toolbox.color === 'red') { console.log('Yes, it is indeed red') } else { console.log('Why would it do that') } ``` |
let toolbox = {
|
Blockquote | > Pretend inferiority and encourage his ignorance. |
Pretend inferiority and encourage his ignorance. |
Horizontal rule |
*** --- ___ |
|
Literals | \\ \` \! \# \* \( \) \[ \] \{ \} \+ \_ \- \. | \ ` ! # * ( ) [ ] { } + _ - . |
GitHub has a Markdown syntax extension of their own, used for Markdown files in repositories or gists. GitHub Flavored Markdown syntactically includes all base Markdown and adds a few GitHub-specific type links along with a few other things.
Action | Syntax | Output | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Strikethrough | ~~Deleted text~~ |
|
||||||||||
User Mention | @literaiiy | @literaiiy | ||||||||||
Emoji | :relaxed: | ☺️ | ||||||||||
Issue/pull request link |
#4157 (relative)
GH-4157 (relative) pallets/flask#4157 |
#4157
GH-4157 #pallets/flask#4157 |
||||||||||
Commits |
https://github.com/pallets/flask/commit/e666f7a69c737fef8236237671be4da5910e9113
e666f7a69c737fef8236237671be4da5910e9113 davidism@e666f7a69c737fef8236237671be4da5910e9113 pallets/flask@e666f7a69c737fef8236237671be4da5910e9113 |
e666f7a
e666f7a davidism@e666f7a pallets/flask@ee666f7a |
||||||||||
Table |
Name | Color ---- | ----- Apple | Red Banana | Yellow Grape | Green Tomato | Red |
|
Markdown Extra is another Markdown extension with a few other features missing in plain Markdown. This is not an extensive list- view that here.
Action | Syntax | Output | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Abbreviation |
*[SASS]: Synatically Awesome Style Sheets SASS, or SCSS, is a syntactically intuitive CSS preprocessor designed by Hampton Catlin. | SASS, or SCSS, is a syntactically intuitive CSS preprocessor designed by Hampton Catlin. | ||||||||||
Numeric (ordered) list |
3. Apples 4. Bananas 5. Oranges 6. Strawberries |
|
||||||||||
Definition |
Flask (n.) : 1. a bottle, usually of glass, having a rounded body and a narrow neck, used especially in laboratory experimentation. : 2. a flat metal or glass bottle for carrying in the pocket |
Flask (n.) 1. a bottle, usually of glass, having a rounded body and a narrow neck, used especially in laboratory experimentation. 2. a flat metal or glass bottle for carrying in the pocket |
||||||||||
Table |
Name | Color ---- | ----- Apple | Red Banana | Yellow Grape | Green Tomato | Red |
|
MultiMarkdown is another, more extensive syntactic extension of Markdown that adds a lot of features focusing greatly on document formatting. This is not at all an exhaustive list, as MultiMarkdown is a very powerful language with a full documentation here.
Action | Syntax | Output | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Footnote |
Text with a footnote[^1]. Text without one. [^1]: Apples are not blue. |
Text with a footnote[1]. Text without one.
1. Apples are not blue |
||||||||||
Definition |
Flask (n.) : 1. a bottle, usually of glass, having a rounded body and a narrow neck, used especially in laboratory experimentation. : 2. a flat metal or glass bottle for carrying in the pocket |
Flask (n.) 1. a bottle, usually of glass, having a rounded body and a narrow neck, used especially in laboratory experimentation. 2. a flat metal or glass bottle for carrying in the pocket |
||||||||||
Table |
Name | Color ---- | ----- Apple | Red Banana | Yellow Grape | Green Tomato | Red |
|
||||||||||
Superscript | y^2 + x^2y3z^ | y2 + x2y3z | ||||||||||
Subscript | C~8~H~10~N~4~O~2~ + O~2 | C8H10N4O2 + O2 | ||||||||||
Ellipsis | ... | … | ||||||||||
LaTeX formula | \\[{\pi}r&2\\] | |||||||||||
Variable |
apples: 5 I have [%apples] apples. | I have 5 apples. | ||||||||||
Table of Contents |
# Table of Contents # {{TOC}} # Page 1 # # Page 2 # # Page 3 # |
Table of ContentsPage 1Page 2Page 3 |