Markdown使用方式

对于一个开发人员来说,必要的文档说明是必不可少的,好的文档说明可以让人快速了解到开发项目的信息,以便于团队协作开发。因而对于写文档,选择Markdown格式文件来说明,则是再好不过的。

而写这份文档,也是因为自己经常忘记Markdown的部分使用方式,所以就自己也总结一下,避免每次使用起来都度娘Google

选择Markdown原因: 易读易写


一、标题

H1-H6标题是用#来标识,顺序递增。(备注:二级标题会自带分割线)

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

另外,H1和H2还能用一下方式显示:

一级标题
===

二级标题
___

二、文本强调

*斜体* or _斜体_
**加粗** or __加粗__
***粗斜体*** or ___粗斜体___

注意:如果在文本中,* 和 _ 两边都有空白的话,就会被当成普通的符号:这是一段* 强调 *文本说明。

如果要在文字前后插入普通的星号或底线,可以用反斜线(转义符):\*这是一段强调文本说明\*

三、列表

无序列表使用 *、+、- 作为列表标记。

* 列表项
* 列表项
* 列表项

+ 列表项
+ 列表项
+ 列表项

- 列表项
- 列表项
- 列表项

有序列表使用数字接着一个英文句点标记。

1. 列表项
2. 列表项
3. 列表项

1. 列表项
- 列表项
- 列表项

有时可能会出现这样情况,首行内容一日期或数字开头:2013. 业绩表。为了避免被转化成有序列表,我们可以在“.”前加上反斜杠(转义符):2013\. 业绩表。


三、引用

在Markdown中,只需要在你希望应用的文字前面加上>就可以了

> 你好

你好


四、代码区块

在Markdown中建立代码区块很简单,只要简单地缩进4个空格或是1个制表符就可以了。

这是一个普通的段落。

    这是一个代码区块(前面有4个空格)。

单行代码加上反引号(`)即可

\`这里是一段单行代码块\`

块级代码加上3个反引号(`)或波浪(~),有「闭合」

\`\`\`
这里是块级代码(这里展示,加上了转义符,否则会被识别为两个代码块)
\`\`\`

~~~
代码块
~~~

五、分割线

在一行中可以使用3个以上的 *、-、_ 来建立一个分割线,行内不能有其他的东西。也可以在星号或者减号中间插入空格

***
* * *
---
- - - 
___________

六、区段元素

链接:Markdown支持两种形式链接语法:行内式参考式

不管是以哪种形式,链接文字都是用[方括号]标记。

行内式只要在方括号后面紧接着圆括号并插入链接即可。

比如:点击蓝色文字就会跳转到百度地址。

点击[蓝色文字](https://www.baidu.com/)就会跳转到百度地址。

如果你想在链接上加上 title 文字,只要在网址后面
跟上用双引号包起来的文字即可。

点击[蓝色文字](https://www.baidu.com/ "百度")就会跳转到
百度地址。

参考式在链接文字的扩哦好后面再接上另一个方括号,而在第二个方括号里面填入用以辨识链接的标记。

点击[百度][id]即可跳转

也可以选择性的在两个方括号中间加上空格
点击[百度] [id] 即可跳转

然后,在文件任意处把这个标记的链接内容定义出来:

\'[id]: https://www.baidu.com/ "百度地址"\'

注意:链接辨识标签可以有字母、数字、空白、标点符号,但是不区分大小写,因此下面两个链接是一样的:

[link][a]

[link][A]


七、图片

图片链接如下:

  • 一个感叹号(!)
  • 接着一个方括号,里面放上图片的代替文字
  • 接着一个圆括号,里面放上图片的地址,最后还可以用引号包住并加上选择性的 ‘title’ 文字
![images](图片的地址)
images

图片的参考式:

![images][id]

\'[id]: 图片的地址 "Optional title"\'

八、表格

| 默认格式 | 左对齐 | 居中 | 右对齐 |
| --- | :--- | :---: | ---: |
| 默认表格内容 | 左对齐表格内容 | 居中对齐表格内容 | 右对齐表格内容 |
| 默认表格内容 | 左对齐表格内容 | 居中对齐表格内容 | 右对齐表格内容 |
默认格式 左对齐 居中 右对齐
默认表格内容 左对齐表格内容 居中对齐表格内容 右对齐表格内容
默认表格内容 左对齐表格内容 居中对齐表格内容 右对齐表格内容
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Markdown概述 宗旨 Markdown 的目标是实现「易读易写」。Markdown 的特点就是,让写作变得更...
    心疼你萌萌哒阅读 12,833评论 1 24
  • Markdown: Syntax 概述 哲学 行内 HTML 特殊字符自动转换 区块元素 段落和换行 标题 区块引...
    未知代码阅读 12,159评论 6 50
  • << 访问 Wow!Ubuntu NOTE: This is Simplelified Chinese Edit...
    临城阅读 11,539评论 4 44
  • 声明: 这份文档派生(fork)于繁体中文版,在此基础上进行了繁体转简体工作,并进行了适当的润色。此文档用 Mar...
    Cellei阅读 10,094评论 0 21
  • Markdown 语法说明 (简体中文版) 概述宗旨兼容 HTML特殊字符自动转换 区块元素段落和换行标题区块引用...
    蚊子Skeeter阅读 8,394评论 3 12