Files
reference/markdown.md
T
2020-12-19 21:40:24 +08:00

2.5 KiB
Raw Blame History

title, date, icon, background, tags, categories, intro
title date icon background tags categories intro
Markdown 2020-12-14 18:28:43 icon-markdown bg-purple-500
md
Markup
Toolkit
A quick reference cheatsheet to the Markdown syntax.

Quick Reference

Headers (atx style)

# h1
## h2
### h3
#### h4
##### h5
###### h6

Headers (setext style)

Header 1
========
Header 2
--------

Blockquotes

> This is
> a blockquote
>
> > Nested
> > Blockquote

Unordered List

* Item 1
* Item 2
    * item 3a
    * item 3b

or

- Item 1
- Item 2

or

+ Item 1
+ Item 2

or

- [ ] Checkbox off
- [x] Checkbox on

Ordered List

1. Item 1
2. Item 2
    a. item 3a
    b. item 3b

Emphasis

*italic*
_italic_
**bold**
__bold__
`inline code`
~~struck out~~
[link](http://google.com)
[link][google]
[google]: http://google.com
<http://google.com>

Horizontal line

----

or

****

Tables

| Column 1 Heading | Column 2 Heading |
| ---------------- | ---------------- |
| Some content     | Other content    |

or

Column 1 Heading | Column 2 Heading
--- | ---
Some content | Other content

Images

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "title")
![Alt text][img]
[img]: http://foo.com/img.jpg

Code

    4 space indent
    makes a code block
```p­ython
def print (str)
 ­ ­ ­ ­pri­nt(str)
```
```js
codeFences.withLanguage()
```

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}