教程
这是一篇讲解如何正确使用 Markdown 的排版示例,学会这个很有必要,能让你的文章有更佳清晰的排版。
引用文本:Markdown is a text formatting syntax.
语法指导
普通内容
这段内容展示了在内容里面一些排版格式,比如:
- 加粗 -
**加粗**
- 倾斜 -
*倾斜*
删除线-~~删除线~~
Code 标记
-`Code 标记`
- 超级链接 -
[超级链接](https://lddgo.net)
- username@gmail.com -
[username@gmail.com](mailto:username@gmail.com)
大标题 - Heading 3
你可以选择使用 H1 至 H6,使用 ##(N) 打头。
NOTE: 别忘了 # 后面需要有空格!
Heading 4
Heading 5
Heading 6
图片
1 |  |
代码块
普通
1 | *emphasize* **strong** |
语法高亮支持
如果在 ``` 后面跟随语言名称,可以有语法高亮的效果哦,比如:
演示 Go 代码高亮
1 | package main |
演示 Java 高亮
1 | public class HelloWorld { |
Tip: 语言名称支持下面这些:
ruby
,python
,js
,html
,erb
,css
,coffee
,bash
,json
,yml
,xml
…
有序、无序、任务列表
无序列表
- Java
- Spring
- IoC
- AOP
- Spring
- Go
- gofmt
- Wide
- Node.js
- Koa
- Express
有序列表
- Node.js
- Express
- Koa
- Sails
- Go
- gofmt
- Wide
- Java
- Latke
- IDEA
任务列表
表格
如果需要展示数据什么的,可以选择使用表格。
header 1 | header 2 |
---|---|
cell 1 | cell 2 |
cell 3 | cell 4 |
cell 5 | cell 6 |
隐藏细节
这里是摘要部分。
这里是细节部分。段落
空行可以将内容进行分段,便于阅读。(这是第一段)
使用空行在 Markdown 排版中相当重要。(这是第二段)
链接引用
1 | [链接文本](链接地址) |
数学公式
多行公式块:
$$ \frac{1}{ \Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{ \frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} { 1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}}{1+\cdots}} } } $$
行内公式:
公式 a2 + b2 = colorredc2 是行内。
脑图
1 | - 教程 |
流程图
graph TB c1-->a2 subgraph one a1-->a2 end subgraph two b1-->b2 end subgraph three c1-->c2 end
graph TB
c1-->a2
subgraph one
a1-->a2
end
subgraph two
b1-->b2
end
subgraph three
c1-->c2
end
时序图
sequenceDiagram
Alice->>John: Hello John, how are you?
loop Every minute
John-->>Alice: Great!
end
甘特图
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
section Section
A task :a1, 2019-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2019-01-12 , 12d
another task : 24d
状态图
stateDiagram [*] --> s1 s1 --> [*]
stateDiagram
[*] --> s1
s1 --> [*]
类图
语法解释:<|--
表示继承,+
表示
public
,-
表示 private
,学过 Java
的应该都知道。
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
Animal : +String gender
Animal: +isMammal()
Animal: +mate()
class Duck{
+String beakColor
+swim()
+quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+bool is_wild
+run()
}
饼图
饼图使用 pie
表示,标题下面分别是区域名称及其百分比。
pie
title Key elements in Product X
"Calcium" : 42.96
"Potassium" : 50.05
"Magnesium" : 10.01
"Iron" : 5
以下的需要特定方法才能解析,typora和大部分markdown编辑器不能解析
图表
1 | { |
五线谱
1 | X: 24 |
Graphviz关系图
graph TD
S([S])
qi(( ))
qi --> S
S --> q1[a]
S --> S[a]
q1 --> S[a]
q1 --> q2[ddb]
q2 --> q1[b]
q2 --> q2[b]
graph TD S([S]) qi(( )) qi --> S S --> q1[a] S --> S[a] q1 --> S[a] q1 --> q2[ddb] q2 --> q1[b] q2 --> q2[b]
1 | graph TD |
Flowchart流程图
1 | st=>start: Start |
脚注
缩进对齐的段落包含在这个脚注定义内。
1 | 可以使用代码块。 |
还有其他行级排版语法,比如加粗和链接。
1 | 这里是一个脚注引用[^1],这里是另一个脚注引用[^bignote]。 |
可以使用代码块。
1
2
还有其他行级排版语法,比如**加粗**和[链接](https://lddgo.net)。
```