MarkDown

简介

markdown 是一门轻量级标记语言, 具有易书写和更改的特点, 可以轻松转化为html(网页).

通常, 是我们书写文档的优秀选择, 以下资料可供语法学习用, 阅读耗时: 20 min, 掌握耗时: 1 day

目录

效果展示

标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

强调

斜体 粗体 粗斜体

列表

无序列表

有序列表

  1. 元素1
  2. 元素2
  3. 元素3

列表组合


链接

Github

图片

替代文本

高亮和代码

普通高亮

// 代码高亮
var test = function() {
    return 'hello world';
};

分割线


区块引用

这是一段引用的文本

表格

水果 蔬菜
榴莲 西兰花
释迦 土豆

使用方法

标题

提供六种可用的标题, 对应到 html 中的h1~h6.
#       一级标题
##      二级标题
###     三级标题
####    四级标题
#####   五级标题
######  六级标题

强调

*斜体*  
**粗体**
_**粗斜体**_

其中 _ 和 * 具有相同的效果, 如: _斜体_.

注意: 当你需要使用 * 本身, 请使用 \* 转义

列表

无序列表

- 元素1
- 元素2
- 元素3

+, - 与 * 具有相同的效果

有序列表

1. 元素1
1. 元素2
1. 元素3

注意: 使用多个 1. 和 1. 2. 3. 效果一致.

列表组合

* 水果
    1. 苹果
    2. 橘子

* 蔬菜
    1. 青椒
    2. 苦瓜

注意: html的显示结果取决于转义环境, vscode, sublime, github, 有道云笔记 可能存在差异.

链接

格式形如:

[显示文本](链接地址)

注意: 表现形式还有其他类型, 此处仅介绍一种

图片

![图片无法正常显示的替代文本ALT](图片链接)

高亮和代码

采用单个反引号的高亮:

`一般的高亮`

三个反引号加上对应标识的代码高亮:

```js
var test = function() {
    return 'hello world';
};
```

注:你可能需要 prism 提供额外的代码高亮美化css样式和js脚本

分割线

---

注意: - 的数量需要>= 3个

区块引用

> 这是一段引用的文本

注意: 作为程序员, 这里通常会放一些命令行指令, 如: > npm run start

表格

水果 | 蔬菜
---|---:
榴莲 | 西兰花
释迦 | 土豆

注意:  : 表示当前列的对齐方向, ---: 右对齐, :--- 左对齐, 默认居中.

更多

编辑器

推荐使用 vscode(程序员), 有道云笔记(文案创作者), 这两者对于markdown 的支持都非常棒. 可以在浏览器中搜索并下载.

vscode 在使用插件后如虎添翼, 有道云笔记还扩展了一些绘制流程图, 甘特图之类的功能.

描述问题

做什么 的时候, 遇到了 什么问题 , 需要, 做什么, 达到什么样的效果.

解决问题

我理解的问题是什么, 我排查了1、2、3..., 最终得出结论, 是由于什么原因导致的, 需要进行 什么操作 可以解决, 后续可以在什么方向上进行进一步优化.

协作参考