Markdown Flashcards
Learn to create documentation using Markdown
Create a heading (level 1, 2, 3, 4, 5, or 6)
Start the line with 1 to 6 ‘#’ characters to represent headings level 1 to 6
Create a paragraph
Start the paragraph with a blank line
Force a line break
End a line with two spaces
Create italic words
Surround the text with * or _.
Example: Both of the words zig and zag are italicized.
Create bold words
Surround the text with ** or __
Example: Both of the words zig and __zag__ are bold.
Create underlined words
You cannot.
Don’t use underlined words since they will look like links.
Create strike-through words
Surround the text with ~~
Example: Both of the words ~~zig~~ and ~~zag~~ are crossed out.
create a numbered (ordered) list
Type the numbers followed by a period at the start of the line
You can use 1. on every line to make editing simpler. The numbers will be updated correctly on the HTML result.
Create a bulletted (unordered) list
Start the line with dash (-)
Plus (+) and asterist (*) work the same
Create an outline (or nested lists)
Indent sub-list lines with three spaces (or more)
Create a link
Place the link’s visible text in square brackets immediately followed by the URL in parentheses.
Example: Google
Specify pop-up text for a link
Place the pop-up text in quotes after the link’s URL.
Example: Google
Show an image
Place the image URL in parentheses after an exclamation point and square brackets.
Example:
Show a block of code
Put 3 backticks on a line before and after the code.
Alternatively, indent the block with four spaces
Apply syntax coloring to a block of code
Put the name of the language after the 3 backticks before the block of code.
Create words with a fixed-width font
Surround the text with single backticks ( ` ).
Example: The term TRUE
represents a 1.
Create a horizontal dividing line on the page
Three underscores on a single line will render as a horizontal rule.
Alternatively, you can use three asterisks or three dashes.
Show a URL as a link
Surround the URL with angle brackets.
Example:
Show a character that normally would be part of a rendering command?
You can escape a character with a backslash character.
Create a table
Separate row cell contents with vertical bars ( | )
Separate rows with new lines
Create a row heading on a table
Create a heading seperator row that contains dashes in each cell.
Align table columns (left, center, or right)
Use colons in the heading separator row to align columns.
Left align with :–
Center align with :–:
Right align with –:
Insert comments that are not rendered
Markdown does not support comments