💾 Archived View for tilde.club › ~filip › tech › cheatsheet › markdown.gmi captured on 2024-05-12 at 15:38:53. Gemini links have been rewritten to link to archived content

View Raw

More Information

⬅️ Previous capture (2022-07-16)

-=-=-=-=-=-=-

markdown

Basic syntax

+----------------------------------------------------------------------------------+
| ELEMENT         | SYNTAX                                                         |
|-----------------|----------------------------------------------------------------|
| Header          | # H1                                                           |
|                 | ## H2                                                          |
|                 | ### H3                                                         |
|                 |----------------------------------------------------------------|
|                 | This is H1                                                     |
|                 | ==========                                                     |
|                 | This is also H1                                                |
|                 | ---------------                                                |
|-----------------|----------------------------------------------------------------|
| Blockquote      | >To be or not to be...                                         |
|-----------------|----------------------------------------------------------------|
| Unordered list  | - Item                                                         |
|                 | - Time                                                         |
|                 | - Mite                                                         |
|                 |----------------------------------------------------------------|
|                 | * or + can be used in place of -                               |
|-----------------|----------------------------------------------------------------|
| Ordered list    | 1. Item 1                                                      |
|                 | 2. Item 2                                                      |
|                 | 3. Item 3                                                      |
|-----------------|----------------------------------------------------------------|
| Task list       | [] To do.                                                      |
|                 | [] To do as well.                                              |
|                 | [x] Already did!                                               |
|-----------------|----------------------------------------------------------------|
| Inline code     | `code`                                                         |
|-----------------|----------------------------------------------------------------|
| Code block      | \`\`\` (three ticks)                                           |
|                 | This is some                                                   |
|                 |  code                                                          |
|                 | \`\`\` (three ticks)                                           |
|-----------------|----------------------------------------------------------------|
| Horizontal rule | --- or - - - (or * instead of -)                               |
|-----------------|----------------------------------------------------------------|
| Links           | This is [an example](http://example.com/ "Title") inline link. |
|                 | [This link](http://example.net/) has no title attribute.       |
|                 |----------------------------------------------------------------|
|                 | This is [an example][id] reference-style link.                 |
|                 | [id]: http://example.com/  "Optional Title Here"               |
|-----------------|----------------------------------------------------------------|
| Italic          | *italized text* or _italized text_                             |
|-----------------|----------------------------------------------------------------|
| Bold            | **bold text** or __bold text__                                 |
|-----------------|----------------------------------------------------------------|
| Link            | [title](https://www.example.com)                               |
|-----------------|----------------------------------------------------------------|
| Image           | ![alt-text](image.jpgi "Optional title")                       |
+----------------------------------------------------------------------------------+

Backslash escape characters

+----------------------------------------+
| BACKSLASH ESCAPE | CHARACTER           |
|------------------|---------------------|
| \\               | backslash           |
| \`               | backtick            |
| \*               | asterisk            |
| \_               | underscore          |
| \{\}             | curly braces        |
| \[\]             | square brackets     |
| \(\)             | parentheses         |
| \#               | hash mark           |
| \+               | plus sign           |
| \-               | minus sign (hyphen) |
| \.               | dot                 |
| \!               | exclamation mark    |
+----------------------------------------+