Markdown 是一种轻量级标记语言,易读易写,被广泛使用于撰写帮助文档
基础语法
标题
使用 #
号可表示 1~6 级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
段落样式
字体
可以使用斜体、粗体和粗斜体三种字体,使用 *
或 _
包裹即可
_斜体文本_ // *斜体文本*
__粗体文本__ // **粗体文本**
___粗斜体文本___ // ***粗斜体文本***
效果如下:
斜体文本
粗体文本
粗斜体文本
分隔线
使用三个或以上的*
、-
、_
来建立分隔线,其中可以插入空格。
_ _ _
---
***
效果如下:
下划线和删除线
文字两端加上 <u>
标签是下划线,加上两个波浪线 ~~
则是删除线
<u>下划线</u> // 简书不支持这种写法
~~删除线~~
效果如下:
<u>下划线</u>
删除线
脚注
这是一段内容内容 [^A]。
[^A]: 这是脚注!!!
列表
Markdown支持 有序列表 和 无序列表 两种形式:
- 无序列表使用
*
或+
或-
标识 - 有序列表使用 数字 加
.
标识
// 标识和内容之间需要空格隔开
* 第一项
* 第二项
* 第三项
1. 第一项
2. 第二项
3. 第三项
效果如下:
- 第一项
- 第二项
- 第三项
- 第一项
- 第二项
- 第三项
区块引用
区块引用是在段落开头使用 >
符号
> 区块内容
// 区块嵌套
> 第一层
> > 第二层
> > > 第三层
// 列表中使用区块,需要在 > 前添加四个空格的缩进
* 第一项
> 区块内容 // 无空格
* 第二项
> 区块内容
效果如下:
区块内容
第一层
第二层
第三层
- 第一项
区块内容
- 第二项
区块内容
代码
段落上的一个函数或片段的代码可以用两个反引号 ` 把它包起来,代码区块使用 4 个空格 或者用上下三个反引号 ` 包裹起来
注:反引号在英文模式下点击键盘esc键下方第一个键即可打出
// 两个反引号
`printf()` 函数
// 上下三个反引号,反引号之间没有空格
` ` `
要展示的内容
` ` `
效果如下:
printf()
函数
要展示的内容
链接或图片
插入链接和图片比较简单,使用方法如下
注:通过img标签可以调节图片高度与宽度,但简书不支持这种方式
[百度](http://www.baidu.com)
<http://www.baidu.com>
![图片名称](https://upload-images.jianshu.io/upload_images/19619388-cc64bb07d2469bda.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果如下:
百度
表格
制作表格使用 |
来分隔不同的单元格,使用 -
来分隔表头和其他行,还可以通过 :
设置表格的对齐方式:
-
-:
冒号在右边设置内容和标题栏居右对齐 -
:-
冒号在左边设置内容和标题栏居左对齐 -
:-:
冒号在两边设置内容和标题栏居中对齐
| 左对齐 | 右对齐 | 中对齐 |
| :----- | ----: | :---: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
效果如下:
左对齐 | 右对齐 | 中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
高级技巧
HTML标签
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等
但简书只支持部分标签
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符 \
**文本加粗**
\*\* 正常显示星号 \*\*
效果如下:
文本加粗
** 正常显示星号 **
公式
Markdown 使用 KaTeX 或者 MathJax 来渲染数学表达式,默认下的分隔符:
-
$...$
或者\(...\)
中的数学表达式将会在行内显示 -
$$...$$
或者\[...\]
或者 ```math 中的数学表达式将会在块内显示
$$
\begin{Bmatrix}
a & b \\
c & d
\end{Bmatrix}
$$
$$
\begin{CD}
A @>a>> B \\
@VbVV @AAcA \\
C @= D
\end{CD}
$$
效果如下:
文字上色
Markdown 并不支持文字颜色改变,目前可以采取折中的方法,将编辑完成的文档导出为html,然后在需要上色的部分手动添加标签<font color='#ff0000'></font>