Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。
本页整理常用的 Markdown 语法,方便使用时随时查阅参考,会及时更新。
中间空一行将分段落,会解析成<p>
标签,换行会解析成<br>
标签:
Paragraphs are separated
by a blank line.
Two spaces at the end of a line
produces a line break.
一般在文章中需要指定各层级的大纲和标题。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
---
可加分隔线
代码 | 样式 | 备注 |
---|---|---|
*斜体* |
斜体的内容 | |
**粗体** |
粗体的内容 | 表示强调 |
***斜体+粗体*** |
斜体+粗体内容 | |
~~删除线~~ |
无序列表:
* apples
* oranges
* pears
或者:
- apples
- oranges
- pears
有序列表:
1. lather
2. rinse
3. repeat
多级列表在行前增加 <tab>
。
格式为[链接文字](链接网址 "标题")
,如:
[百度](https://www.baidu.com "百度搜索")
以下为新窗口打开:
[百度](https://www.baidu.com){:target="_blank"}
效果为:
另外,用 < > 包起来,网址和邮箱会自动加上链接
<http://example.com/>
<address@example.com>
效果为:
在技术文章中经常会需要描述相关代码,分成行内的代码命令和代码块,用反引号将代码包起来。
从 `print('Hello world!')`开始代码之旅。(用``把代码括起来)
会显示成以下形式:
从 print('Hello world!')
开始代码之旅。
代码块用以下格式,注意:没有[]
[```]<语言名称>
<代码内容>
[```]
例如:
```python
w = 'Hello word!'
print(w)
会输出:
```python
w = 'Hello word!'
print(w)
表格一般显现结构化的内容,让内容更加有条理便于阅读和理解。
| 表头1 | 表头2 |
| ----- | ----- |
| 列1.1 | 列2.1 |
| 列1.2 | 列2.2 |
最终效果是:
表头1 | 表头2 |
---|---|
列1.1 | 列2.1 |
列1.2 | 列2.2 |
除此之外还可以定义当列的对齐方式,下边三列分别是左对齐、居中、右对齐:
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
MD 为纯文本的输入方式,一般需要将图片传到服务器(或者图床,有些 MD 编辑器支持图片上传功能),然后再用 MD 代码进行显示处理,一般语法为:
![alt](/file/pic/2019/filename.jpg "title")
![LOGO ](https://www.baidu.com/img/baidu_logo.gif "百度")
最终效果是:
图片的大小和样式,可以用 CSS 来控制,下文会讲到加 CSS 样式名。
内容块如果需要样式,在内容之后加 {.bg_txt}
会解析成:
<p class="bg_txt">有时候需要给内容引用样式,在内容之后加</p>
内容块如果需要内联样式,在内容之后加 {: style="float:right"}
会解析成:
<p style="float:right">内容块如果需要内联样式,在内容之后加</p>
内容块如果需要增加属性和值,可以在内容之后加 {data=081414}
会解析成:
<p data='081414'>内容块如果需要内联样式,在内容之后加</p>
为这句话增加 ID
{: #custom-id}
会解析成:
<p id='custom-id'>为这句话增加 ID</p>
![alt](/file/pic/2019/filename.jpg)
*The caption for my image*
{.center}
![alt](/file/pic/2019/filename.jpg){: style="float:right"}
![flower](/image/flower.png)
{:.center-image, height="300px", width="150px"}
> 冬天到了,春天还会远吗?
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
First Term
: This is the definition of the first term.
Second Term
: This is one definition of the second term.
: This is another definition of the second term.
效果:
First Term
: This is the definition of the first term.
Second Term
: This is one definition of the second term.
: This is another definition of the second term.
[TOC]
可以按 Html 的 H 等级生成多级内容目录
TODO
TODO
正在整理中。。。
更新时间:2024-04-14 08:43:49 标签:markdown 文档