使⽤MarkDown,编写html格式的项⽬帮助⼿册(含左侧⽬录
树)
使⽤MarkDown编写帮助⼿册说明
1.安装MarkDown软件
l
l 安装后如果在左侧输⼊内容后在右侧不显⽰,可安装:
l 提⽰缺少directx可安装directx
l 安装完成后打开需要输⼊注册码
注册码信息如下:
邮箱:
Soar360@live
授权秘钥:
GBPduHjWfJU1mZqcPM3BikjYKF6xKhlKIys3i1MU2eJHqWGImDHzWdD6xhMNLGVpbP2M5SN6bnxn2kSE8qHqNY5QaaRxmO
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++(或其他的⽂本编辑⼯具,有就可以不⽤安装)
notepad++4.将⽣成的Html复制到模板⽂件中,⽣成左侧⽬录树
打开⽤MarkDown⽣成的Html⽂件,举例如⽂件夹中的
将《帮助⼿册Markdown-html⽂件.html》⽂件中body之间的内容,
复制到《帮助⼿册html模板.html》中内容分割线下⽅
复制好后保存,⽤浏览器打开【帮助⼿册html模板.html】,可以在浏览器中访问帮助⼿册
5.修改帮助⼿册html的title
编辑【帮助⼿册html模板.html】修改title之间的内容即可
将【帮助⼿册html模板.html】重命名为【帮助⼿册】⾄此帮助⼿册就设置完成了。
这种⽅式,实施⼈员、需求⼈员或者是测试⼈员直接编写好后就可以直接⽣成Html格式,减少开发⼯作量,也避免了帮助中的截图复制到word中模糊的问题,客户在⽹站上浏览帮助也是⾮常⽅便的。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论