MarkDown语法小结
标题
# H1 |
强调
粗体
**rendered as bold text** |
效果:
rendered as bold text
斜体
_rendered as italicized text_ |
效果:
rendered as italicized text
删除线
~~Strike through this text.~~ |
效果:
Strike through this text.
链接
自动链接
<https://nevermoreaken.github.io/> |
效果:
https://nevermoreaken.github.io/
内联链接
[Blog](https://nevermoreaken.github.io/) |
效果:
链接标题
[Blog](https://nevermoreaken.github.io/ "欢迎光临") |
效果(鼠标悬停详情):
https://nevermoreaken.github.io/
锚点
命名锚点使您能够跳转到同一页面上的指定锚点。例如,这些章节中的每一章:
# Table of Contents |
将跳转到这些部分:
## Chapter 1 |
图片
和链接的语法类似,注意前面的感叹号。
 |
在文档中定义url变量的方法:
[id]: https://raw.githubusercontent.com/nEvErMoReaken/picodemo/main/img/makima.jpg "MarkText logo" |
![makima][id] |
效果:
块引用
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante |
效果:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante
块引用也可以嵌套:
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. |
Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor
odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
列表
无序
可以使用以下任何符号来表示每个列表项的项目符号:
* valid bullet |
例如:
+ Lorem ipsum dolor sit amet |
效果:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
有序
1. Lorem ipsum dolor sit amet |
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
窍门
有时列表会发生变化,当它们发生变化时,重新排序所有数字会很痛苦。Markdown 通过允许您简单地1.
在列表中的每个项目之前使用来解决这个问题。
1. Lorem ipsum dolor sit amet |
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
待办
- [ ] Lorem ipsum dolor sit amet |
效果:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
待办事项列表中的链接
- [ ] [foo](#bar) |
效果:
表
(建议直接用工具生成)
通过在每个单元格之间添加管道作为分隔符,并在标题下方添加一行破折号(也由条分隔)来创建表格(这行破折号是必需的)。
- 管道不需要垂直对齐。
- 表左右两侧的管道有时是可选的
- 分隔符行中的每个单元格必须使用三个或更多破折号
| Option | Description | |
效果:
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
居中对齐,左对齐,右对齐
建议用文本编辑器
代码
内联代码
用一个反引号包裹内联代码片段:`
。
例如,要<div></div>
与其他文本内联显示,只需将其包裹在反引号中。
For example, to show `<div></div>` inline with other text, just wrap it in backticks. |
代码块
三个连续的反引号,称为“代码围栏”,用于表示多行代码:```
.
例如:
```html |
效果: |
语法高亮
要激活代码块中语言的正确样式,只需在第一个代码 “fence”: 之后直接添加您要使用的语言的文件扩展名```js
,语法高亮将自动应用于呈现的 HTML(如果支持解析器)。例如,将语法高亮应用于 JavaScript 代码:
```js |
```js |
键盘键
Github-Flavored Markdown (GFM) 允许您突出显示键盘键。
To copy, please press <kbd>CmdOrCtrl</kbd>+<kbd>C</kbd> |
To copy, please press CmdOrCtrl+C
To paste, please press CmdOrCtrl+V
emoji
Github-Flavored Markdown (GFM) 也支持 Emojis。😍 😄 😂
要添加表情符号,只需用冒号将表情符号名称括起来,如下所示:
:heart: :zap: :cow: :dollar: :star: :tada: |
效果:
:heart: :zap: :cow: :dollar: :star: :tada:
PlantUML
大概看了一下,大概是画UML类图并且植入,详情见PlantUML 网站
HTML
<
任何介于和之间的看起来像 HTML 标记的文本>
都将被解析为原始 HTML 标记并呈现为 HTML 而不会转义。
例子:
**Visit <a href="https://github.com">Jon Schlinkert's GitHub Profile</a>.** |
效果:
Visit Jon Schlinkert’s GitHub Profile.
转义
任何 ASCII 标点字符都可以使用单个反斜杠进行转义。
\*this is not italic* |
效果:
*this is not italic*