Markdown语法
Markdown
基本语法
支持 CommonMark
所有语法
标题段落
|
|
空一行分段落
|
|
- 分割线
---
***
- 引用
|
|
冬天到了,春天还会远吗?
文字效果
*斜体* 斜体的内容
**粗体** 粗体的内容
***斜体+粗体*** 斜体+粗体内容
~~删除线~~ 删除线
Lorem ipsum dolor <kbd>CTRL</kbd> + <kbd>C</kbd>
斜体 斜体的内容
粗体 粗体的内容
斜体 + 粗体 斜体 + 粗体内容
删除线 删除线
Lorem ipsum dolor CTRL + C
列表
- 无序列表:
* fruit
* apples
* oranges
* pears
或者:
- fruit
- apples
- oranges
- pears
或者:
+ fruit
+ apples
+ oranges
+ pears
效果:
fruit
- apples
- oranges
- pears
或者:
fruit
- apples
- oranges
- pears
或者:
fruit
- apples
- oranges
- pears
有序列表:
1. lather
2. rinse
3. repeat
效果:
- lather
- rinse
- repeat
- 任务列表:
- [x] Checked task item
- [x] Another checked task item
- [ ] Unchecked task item
效果:
- Checked task item
- Another checked task item
- Unchecked task item
超链接
分为三种跳转类型:
- 跳转到外部链接
- 跳转到系统内其他页面
- 本页面内部跳转
格式如下
[显示名称](地址 "鼠标移动到链接时的提示信息")
外部链接
|
|
效果如下: 百度
跳转到系统内其他页面
|
|
效果如下:
本页面内部跳转
支持
- 小标题跳转
- 任意位置跳转
小标题跳转
支持跳转到 #
号开头的标题
用 #
号开头
|
|
任意位置跳转
待跳转的地方用 span
包裹,通过 id
进行跳转
|
|
链接:
|
|
效果:
普通标题
普通小标题,链接时 #
号后面直接填写标题
带 空格 标题
标题带空格,链接时 #
号后面
替换成 -
222 数字开头标题
数字开头的标题,链接时 #
号后面添加 h-
任意跳转示例:Markdown 是一个 Web 上使用的文本到 HTML 的转换工具,可以通过简单、易读易写的文本格式生成结构化的 HTML 文档。目前 Stackoverflow 网站使用这种格式来提问。
代码
|
|
单行代码 print('Hello world!')
多行代码
|
|
表格
|
|
效果:
Syntax1 | Syntax | Description | Test Text |
---|---|---|---|
Header1 | Header | Title | Here’s this |
Paragraph1 | Paragraph | Text | And more |
图片
|
|
效果:
Emoji
:apple:
Can be also be used :fire: inline
效果:
🍎
Can be also be used 🔥 inline
其他支持
提示信息
|
|
效果:
Lorem ipsum dolor sit amet
Consectetur adipiscing elit {.is-info}
Consectetur adipiscing elit {.is-success}
Consectetur adipiscing elit {.is-warning}
Consectetur adipiscing elit {.is-danger}
列表
- 有序列表
|
|
效果:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Morbi vehicula aliquam
- 无序列表
- Grid Item 1
- Grid Item 2
- Grid Item 3
{.grid-list}
- [Lorem ipsum dolor sit amet *Subtitle description here*](https://www.google.com)
- [Consectetur adipiscing elit *Another subtitle description here*](https://www.google.com)
- [Morbi vehicula aliquam *Third subtitle description here*](https://www.google.com)
{.links-list}
效果:
- Grid Item 1
- Grid Item 2
- Grid Item 3 {.grid-list}
和
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Morbi vehicula aliquam {.links-list}
Superscript
Lorem ^ipsum^ dolor
效果:
Lorem ^ipsum^ dolor
Mermaid Diagrams
|
|
效果:
PlanutUML
|
|
@startuml
package "Some Group" {
HTTP - [First Component]
[Another Component]
}
node "Other Groups" {
FTP - [Second Component]
[First Component] --> FTP
}
cloud {
[Example 1]
}
database "MySql" {
folder "This is my folder" {
[Folder 3]
}
frame "Foo" {
[Frame 4]
}
}
[Another Component] --> [Example 1]
[Example 1] --> [Folder 3]
[Folder 3] --> [Frame 4]
@enduml
Shortcut
测试 admonition
一个 注意 横幅
|
|
一个 注意 横幅一个 注意 横幅一个 注**意 横幅一个 注意** ==横幅==
打字机效果
段落
代码
center-quote
hello world
this is a center-quote shortcode example.