使用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进行产品手册的管理，请多多关注，比心~
使用Markdown编写手册相关推荐
- 中文 Markdown 编写格式规范的命令行工具 lint-md
lint-md 用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便集成 ci.Cli tool to lint your markdown file for Chin ...
- markdown数学公式手册
这几天写博客,需要写一些数学公式,在百度上找了半天关于markdown数学公式手册,都没有找到,好不容易在google上找到,这里分享给大家,好用记得点赞哦!!! 手册链接:https://www ...
- Bat(批处理)文件编写手册（一）
一.批处理常用的DOS命令篇 1.`echo命令` 2.`@命令` 3.`pause命令` 4.`rem命令` 5.`::命令` 6.`call命令` 7.`cd命令` 8.`dir命令` 9.`at ...
- 如何优雅的用MarkDown编写一份简历
如何优雅的用MarkDown编写一份简历 背景 近期笔者因故离开了上家公司,因为前段时间忙于工作和离职等事情,疏于更新博客,为此笔者感到了深深的罪恶感以及发自良心的谴责.2020已经过去大半,自己立的 ...
- markdown编写一个幻灯片快速入门版
markdown编写一个幻灯片快速入门版 阅读前请仔细观看下列内容: 这些内容的基础都是在vscode或者atom上,请下载插件Markdown Preview Enhanced 不然这些元素都无法运 ...
- Markdown编写表格模板
作者:LoveEmperor-王子様 Markdown编写表格模板 在编写表格时,很容易格式错误,与用错标题标签,在这里记录下 模板写法: 注意左边首|要靠最左,不能有空格 表格上的标题要#,不建议使 ...
- markdown编写Python简历模板
#1024程序员节 勋章听说很帅啊! markdown编写Python简历模板 ... 等我整理放上来,先占个坑... ...
- 基础001.Markdown编写云笔记
笔记的记录方式 1. 传统的纸记录方法. 2. Word或常见文本记录. 3. 云笔记及Markdown语言的记录方式. Markdown语言 优点 简明教程 FSCapture截图 图床 批量生成图 ...
- Django实战之添加markdown编写文章的支持
书接https://dongfangyou.blog.csdn.net/article/details/105323313 Markdown 主要依赖于Python第三方库,相关的库有很多 这里我们选 ...
- 写得好的html网页,优化网站排名-使用Markdown编写更好的内容和HTML
1.内容创作的悲剧 因此,首先您必须了解:内容创建的一个巨大悲剧是HTML.如果你是一位作家.制片人或类似的人,你在创作内容时,总是会遇到这样的问题:想要让博客文章现场直播,或者想要获得网页直播,或者 ...
最新文章
- javascript 死循环
- Android 项目结构说明
- 科大星云诗社动态20210516
- DDR3 LAYOUT RULES
- 查找三 哈希表的查找
- c语言字体取模软件下载,非常好用的lcd汉字取模软件下载_非常好用的lcd汉字取模软件官方下载-太平洋下载中心...
- TeeChart插入
- 机器学习成长之路——开篇引题
- python3.5安装PyHook3
- vue学习-v-if v-for优先级、data、key、diff算法、vue组件化、vue设计原则、组件模板只有一个根元素、MVC.MVP,MVVM
- 招商银行一网通支付(php接入招商银行一网通支付)
- 脏写、脏读、不可重复读、幻读
- JDK8与JDK9新特性学习
- P1460 [USACO2.1]健康的荷斯坦奶牛 Healthy Holsteins
- oracle用户之间授权查询
- python猜单词游戏_python实现猜单词游戏
- 第73节：Java中的HTTPServletReauest和HTTPServletResponse
- ios 文本翻转_UIButton,UILabel文字旋转(倾斜)
- Docker快速入门总结笔记
- C语言：任意从键盘输入一个三位整数，要求正确分离它的个位，十位和百位数，并分别在屏幕上输出。