使用Markdown编写手册

前言：

本次主要介绍使用markdown工具，进行产品手册的编辑和维护。包含：

        （一）安装markdown

        （二）markdown的使用

        （三）安装markdown目录转换工具

---

（一）安装markdown

安装之前需要先安装Visual Studio Code（简称：VScode）工具。

网盘下载链接：https://pan.baidu.com/s/1yP7Y_IPeSg-pIKnG94GhnQ 提取码：rvlm

（需要强调下，还有很多软件也支持.md文件，我们这里使用VScode是为了后续将手册push到git上进行版本管理，不代表只能用这个软件哦）

1. 打开Visual Studio Code软件，进入应用商店，

搜索：Markdown Preview Enhanced 进行安装

搜索：Markdown PDF 进行安装

3. 安装后重启VScode软件再进行操作。

（二）Markdown的使用

1. 通过VScode打开一个文件夹（空或已有md文件的目录均可以）。

2. 新建一个后缀为demo.md的文件夹，右侧将打开一个空的md文件，我们可以进行编辑。

3. 到这里我们就可以编辑一个md文件了，编辑后可以点击预览。

4. 我们可以将md导出成PDF或HTML。

 我们有没有发现，导出成html后左侧没有目录，这就是我们下面要说到的，怎么给Markdown生成侧边目录？

（三）安装markdown目录转换工具

1. 下载node包：下载 | Node.js 中文网

 

2. 下载后，直接双击：node-v16.14.0-x64.msi 进行安装，安装简单这里不再细说。

3. 安装 i5ting_toc

安装node ok后，输入cmd打开终端，输入：npm install i5ting_toc -g

i5ting_toc 用法：

4. 转换html，在cmd上输入i5ting_toc -f [需要转换文件名].md

（这里记得执行时，一定要先切换到md所在同级目录！！）

默认在同级目录生成preview文件夹，打开preview下的同名.html文件或者直接i5ting_toc -o可预览。

通过这个工具转换的md5会有侧边目录哦。

补充说明：markdown虽然操作简单，但是有些语法还需要我们记忆，这里给大家推荐一个免费版的markdown编辑器--Typora，里面操作和word差不多，安装后就不用再记那些繁琐的语法规则了。（下载地址：https://pan.baidu.com/s/1UfkbitcviD9Dz1ZGv16Q3A  提取码：8q6e）

Hello Test，今天我们markdown的使用就介绍完了，用它来维护产品的用户手册和安装指南是很实用的，后面我也会介绍怎么通过git进行产品手册的管理，请多多关注，比心~