Files
reference/source/_posts/markdown.md
T
2022-12-30 10:47:54 +08:00

238 lines
3.0 KiB
Markdown

---
title: Markdown
date: 2020-12-14 18:28:43
background: bg-[#6319bf]
tags:
- md
- Markup
- text
- format
categories:
- Programming
intro: This is a quick reference cheat sheet to the Markdown syntax.
---
Markdown Quick Reference
---------------
### Headers (atx style)
```markdown
# h1
## h2
### h3
#### h4
##### h5
###### h6
```
### Headers (setext style)
```markdown
Header 1
========
```
```markdown
Header 2
--------
```
### Blockquotes
```markdown
> This is
> a blockquote
>
> > Nested
> > Blockquote
```
### Unordered List {.row-span-2}
```markdown
* Item 1
* Item 2
* item 3a
* item 3b
```
or
```markdown
- Item 1
- Item 2
```
or
```markdown
+ Item 1
+ Item 2
```
or
```markdown
- [ ] Checkbox off
- [x] Checkbox on
```
### Ordered List
```markdown
1. Item 1
2. Item 2
a. item 3a
b. item 3b
```
### Links
```markdown
[link](http://google.com)
```
```markdown
[link][google]
[google]: http://google.com
```
```markdown
<http://google.com>
```
### Emphasis
```markdown
*italic*
_italic_
```
```markdown
**bold**
__bold__
```
```markdown
`inline code`
~~struck out~~
```
### Horizontal line
Hyphens
```markdown
---
```
Asterisks
```markdown
***
```
Underscores
```markdown
___
```
### Code
~~~markdown
```javascript
console.log("This is a block code")
```
~~~
```markdown
~~~css
.button { border: none; }
~~~
```
```markdown
4 space indent makes a code block
```
#### inline code
```markdown
`Inline code` has back-ticks around it
```
### Tables {.col-span-2}
```markdown
| Left column | Center column | Right column |
|:------------|:-------------:|-------------:|
| Cell 1 | Centered | $1600 |
| Cell 2 | Cell 3 | $12 |
```
Simple style
```markdown
Left column | Center column | Right column
:----------:|:-------------:|:-----------:
Cell 1 | Centered | $1600
Cell 2 | Cell 3 | $12
```
A markdown table generator: [tableconvert.com](https://tableconvert.com/)
### Images {.col-span-2}
```markdown
![GitHub Logo](/images/logo.png)
![Alt Text](url)
```
#### Image with link
```markdown
[![GitHub Logo](/images/logo.png)](https://github.com/)
[![Alt Text](image_url)](link_url)
```
#### Reference style
```markdown
![alt text][logo]
[logo]: /images/logo.png "Logo Title"
```
### Backslash escapes
| Characters | Escape | Description |
|------------|--------|-------------|
| \\ | \\\\ | backslash |
| \` | \\\` | backtick |
| \* | \\\* | asterisk |
| \_ | \\\_ | underscore |
| \{\} | \\\{\} | curly braces |
| \[\] | \\\[\] | square brackets |
| \(\) | \\\(\) | parentheses |
| \# | \\\# | hash mark |
| \+ | \\\+ | plus sign |
| \- | \\\- | minus sign \(hyphen\) |
| \. | \\\. | dot |
| \! | \\\! | exclamation mark |
{.show-header}