Markdown上手指南

前言

markdown 是一门很实用的标记语言，如果有HTML 基础学起来会很是快。

演示效果均是从typora 展现的,为何用它，由于它是一个成熟的 md 编辑器！

• markdown 所见即所得, 部分还增长了人性化的交互(好比代码高亮)
• 支持公式
• 支持大部分的拓展语法
• 支持主流的流程图渲染

舒适提示:

已经会的不用往下面看了,文章的目的是给咱们研发组的小伙伴快速上手的。

由于前端这块的文档基本切换到MD来维护，花了点时间录制了一波GIF演示

基础语法

基础语法是支持度最高的,市面上主流的 markdown 解析器基本都支持。

拓展语法须要借助不一样的插件或者库实现,通用性没那么强。

注意点 : 全部标记仅支持英文模式(半角)！！

标题

# H1
## H2
### H3
#### H4
##### H5
###### H6
复制代码

文字强调

粗体

**我是粗体**
复制代码

粗体

_我是斜体_
*我也是斜体*
复制代码

着重强调(粗体+斜体)

***我着重的强调,再哔哔我嫩死你***
复制代码

列表

有序列表

有序列表的格式是:   数字小数点+空格+文本

1. afdslf
2. fsadfae
3. Ewarewr
复制代码

无序列表

格式: 横线(星号) + 空格 + 文本

- asdklfjsaf 
- fasdfsadf 


* 发水电费卢卡斯
* 发顺丰惹我
复制代码

列表混合及嵌套

无论是有序列表仍是无序列表,都支持多级嵌套，也支持有序无序列表混用。

如果增长一些外部扩展，还支持todo混入

- 测试啊
  - 真的测试啊
  - 你不信啊
 1. 我是三级有序列表
 2. 呵呵哒
  - 唉
复制代码

外部连接

格式：方括号小括号(连接)

[点击我就跳到百度了](https://www.baidu.com) 
复制代码

图片引用展现

格式：感叹号+外部连接的格式。 连接支持相对引用！

![closeup photo of computer code screengrab](https://images.unsplash.com/photo-1524666643752-b381eb00effb?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=1000&q=80)
复制代码

水平分割线

格式: 空行 ---

呼叫逗比

---

逗比回应你了
复制代码

引用

通常你引用了别处的内容，这个就能够用上了

格式： 大于号(>) + 空格 + 内容

>床前明月光
> >疑是地上霜
> > - 这是**李白**的诗歌 
复制代码

行内代码

行内代码的效果通用都是灰色,不能针对语法高亮

格式：反引号+内容+反引号

`module.exports= ()=>{}`
复制代码

拓展语法

表格

表格的语法也很简单，就是写的多一些，由于列越多写的越多。

默认的列左对齐,也支持设置居中和右对齐, 横杆大于等于3， 列的竖必须闭合才能表明一列！

• 默认对齐(左对齐) :  :----
• 居中对齐 : :---:
• 右对齐: ---:

| 默认左对齐     |       居中对齐       |     右对齐 |
| :--- | :------------------: | -------: |
| 啊水电费萨德 | 阿斯顿六块腹肌阿斯顿 | 发水电费 |
| 1321 | 432 | 654645 |
| 啊水电费萨德 | 阿斯顿六块腹肌阿斯顿 | 发水电费 |
| 1321 | 432 | 654645 |


复制代码

代码高亮

代码高亮看采用的是什么高亮库了,好比前端这块有用highlightjs 或 prism的。
因此高亮支持语言也得看高亮库是否支持！！

复制代码

我是纯文本 plain text，由于我没有指定语言

```javascript
// 我是 js 高亮
import vue from 'vue';
复制代码

# 我是 bash 高亮
ls -l | grep 'haha'
复制代码

任务列表

这个很实用，就是展现待办事项效果, 算是列表的变种，能够混合使用

• - [ ] text : 方括号内部空格代指是待办事项
• -  [x] text : 方括号内部 x代指事项已经完成

- v1版本
  - [x] 用户接口打通
  - [ ] 用户接口合并
 - [ ] 合并重复字段
 - [ ] 呵呵到

复制代码

文字高亮

格式：双等号+文本+双等号

===据说我要呗高亮了===

==是啊==

==亮瞎眼了==
复制代码

脚注

这个东西在写文献用的最多

格式：

• 声明: [^text]: description
• 引用: hello[^text]

[^李白]: 一个喝酒的诗人

床前明月光[^李白]

复制代码

删除线

你没看错，这不属于第一个版本的草案的内容，也是后续才有的

格式：两个波浪线+文本+波浪线

~~我给删除了，你看~~
复制代码

下标

把字缩放，适合用来表现公式类的

H~2~o
复制代码

mermaid

mermaid 不单单能够画流程图,具体能够看mermaid 上手指南

总结

Markdown 的标准方案一直都没有更新,如今的加强大多都是依赖第三方实现。好比更加丰富的表格功能,数学公式等等！可是这并不能阻挡 md 流行, 随时可见的身影，代码社区，编程工具内置实现等等。有不对之处请留言,谢谢阅读