content
foreword
Some project descriptions written in markdown syntax are often seen on github. Markdown is actually a lightweight markup language, which is very concise and supports the insertion of html code.
I like to use it for two main reasons: the first is to force, and the second is to facilitate
editor
Currently the online editor I use is the StackEdit
portal: https://stackedit.io
1. Anchor: * + [title] + (directory to jump to)
grammar:
### [需要跳转的目录]{#锚点}
### 锚点 // 注意,两个文字要对得上
Effect:
Anchor
Anchor
2. Title
1. When the # symbol increases, the weight decreases, which is equivalent to h1~h6
grammar:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
以此类推····
Effect:
first-level title
secondary title
tertiary heading
Level 4 heading
Level 5 heading
Level 6 heading
2. You can also set the title directly through "=" or "-"
grammar:
一级标题
======================
二级标题
---------------------
Effect:
first-level title
secondary title
3. Semantic Marking
Semantic markup:
describe | Effect | code |
---|---|---|
Italics | Italics | *斜体* |
Italics | Italics | _斜体_ |
bold | Italics | **斜体** |
bold + italic | bold + italic | ***斜体*** |
code highlighting | 代码高亮 |
代码高亮 |
strikethrough | ~~删除线~~ |
4. Hyperlinks
1. Text hyperlinks: square brackets (link content) + parentheses (link address)
grammar:
[文字超链接](http://www.cnblogs.com/youthsnail)
Effect:
2. Link pictures:
Syntax: exclamation mark + square brackets + link address
![](https://m.baidu.com/static/index/plus/plus_logo.png)
Effect:
3. Automatic link:
Syntax: wrapped in angle brackets
<htttps:www.baidu.com>,相当于a标签
Effect:
5. Code block
grammar:
键盘左上角的三个点
Effect:
code
6. Citation
grammar:
> 引用
> 多行
>> 多层级
>>>多层级
Effect:
Quote
multiple linesmulti-level
7. Sequence
1. Ordered list: serial number + . (note the space)
- ordered list 01
- ordered sublist 01
- ordered list 02
- Ordered list 03 #### 2. Unordered list: *
- Unordered list 01
- Unordered sublist 01
- Unordered list 02
- Unordered list 03
8. Forms
Remarks: :
Represents the alignment, do not have a space between:
** and **, otherwise the alignment will be somewhat incompatible|
grammar:
|Name|Academy|score|
|-| :-: | -: |
| Harry Potter | Gryffindor| 90 |
| Hermione Granger | Gryffindor | 100 |
| Draco Malfoy | Slytherin | 90 |
Effect:
Name | Academy | score |
---|---|---|
Harry Potter | Gryffindor | 90 |
Hermione Granger | Gryffindor | 100 |
Draco Malfoy | Slytherin | 90 |
9. Separator
grammar:
***
---
Effect:
10. Footnotes
grammar:
脚注[^1]
Effect:
Footnote [^ 1]