使用MarkDown，编写html格式的项目帮助手册（含左侧目录树）

使用MarkDown编写帮助手册说明

1.安装MarkDown软件

l 

l  安装后如果在左侧输入内容后在右侧不显示，可安装：

l  提示缺少directx可安装directx

l  安装完成后打开需要输入注册码

注册码信息如下：

邮箱：

Soar360@live.com

授权秘钥：

GBPduHjWfJU1mZqcPM3BikjYKF6xKhlKIys3i1MU2eJHqWGImDHzWdD6xhMNLGVpbP2M5SN6bnxn2kSE8qHqNY5QaaRxmO3YSMHxlv2EYpjdwLcPwfeTG7kUdnhKE0vVy4RidP6Y2wZ0q74f47fzsZo45JE2hfQBFi2O9Jldjp1mW8HUpTtLA2a5/sQytXJUQl/QKO0jUQY4pa5CCx20sV1ClOTZtAGngSOJtIOFXK599sBr5aIEFyH0K7H4BoNMiiDMnxt1rD8Vb/ikJdhGMMQr0R4B+L3nWU97eaVPTRKfWGDE8/eAgKzpGwrQQoDh+nzX1xoVQ8NAuH+s4UcSeQ==

2.MarkDown的简明使用介绍

l  写标题：#开头代表一级标题，##开头代表二级标题，###开头代表三级标题，标题的设置依次类推

l  加粗字体：选中需要加粗的文字，点击工具栏上方的加粗按钮

l  段落首行缩进： 在文字前加：  

l  添加图片：复制一下代码后修改图片名称和图片尺寸，图片尺寸一定要设置成跟图片的实际尺寸一致不然在浏览器中会显示不清楚。

图片的路径需要设置正确，一般的在帮助手册所在目录创建一个imgs文件夹用于存放帮助手册中的图片，“./imgs/主机厂概览.pgn”其中点.代表当前路径跟帮助手册的html文件在一个目录下。

<imgsrc="./imgs/8.png"width = "595px" height = "141px" alt="8" align=center /> 

l  生成HTML：在MarkDown中编写好帮助手册后，可通过File-->Expor-->ExportHtml导出Html文件

3. 安装notepad++（或其他的文本编辑工具，有就可以不用安装）

4.将生成的Html复制到模板文件中，生成左侧目录树

打开用MarkDown生成的Html文件，举例如文件夹中的

 

将《帮助手册Markdown-html文件.html》文件中body之间的内容，

复制到《帮助手册html模板.html》中内容分割线下方

复制好后保存，用浏览器打开【帮助手册html模板.html】，可以在浏览器中访问帮助手册

5.修改帮助手册html的title

编辑【帮助手册html模板.html】修改title之间的内容即可

 

将【帮助手册html模板.html】重命名为【帮助手册】至此帮助手册就设置完成了。

这种方式，实施人员、需求人员或者是测试人员直接编写好后就可以直接生成Html格式，减少开发工作量，也避免了帮助中的截图复制到word中模糊的问题，客户在网站上浏览帮助也是非常方便的。

附：资料(含MarkDownpad2的安装包注册码、Notepad++的安装文件)下载地址：链接：https://pan.baidu.com/s/1dE9TLxJ 密码：if0g