使用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
使用MarkDown,编写html格式的项目帮助手册(含左侧目录树)相关推荐
- 中文 Markdown 编写格式规范的命令行工具 lint-md
lint-md 用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便集成 ci.Cli tool to lint your markdown file for Chin ...
- 如何优雅的用MarkDown编写一份简历
如何优雅的用MarkDown编写一份简历 背景 近期笔者因故离开了上家公司,因为前段时间忙于工作和离职等事情,疏于更新博客,为此笔者感到了深深的罪恶感以及发自良心的谴责.2020已经过去大半,自己立的 ...
- markdown编写一个幻灯片快速入门版
markdown编写一个幻灯片快速入门版 阅读前请仔细观看下列内容: 这些内容的基础都是在vscode或者atom上,请下载插件Markdown Preview Enhanced 不然这些元素都无法运 ...
- Markdown编写表格模板
作者:LoveEmperor-王子様 Markdown编写表格模板 在编写表格时,很容易格式错误,与用错标题标签,在这里记录下 模板写法: 注意左边首|要靠最左,不能有空格 表格上的标题要#,不建议使 ...
- 如何利用 notedown 完成 ipynb与markdown之间的格式转换?
简 介: 使用Convert IPython Notebooks to markdown (and back)中的downnote可以方便将IPYNB与Markdown格式进行转换.本文对于noted ...
- Markdown常用基本格式
Markdown常用基本格式 标题 井号#加空格加题目,enter键成为标题.井号个数表示题目等级: 这是一个一级标题 这是一个二级标题 这是一个三级标题 略略略略 略略略略略 最多到六级标题 文本 ...
- 计算机PPT中项目编号怎么弄,电脑技巧收藏家电脑基础设置幻灯片格式:项目符号和编号...
设置幻灯片格式 :项目符号和编号 什么是项目符号和编号呢?如果我们在文档中输入"1. ",然后把光标移动到这一行的末尾,敲一下回车,下面就自动出现了"2. ", ...
- 编写DLL格式的wireshark插件
编写DLL格式的wireshark插件 在windows环境下,编写wireshark插件,插件格式为dll 编写过程总结: 首先,需要按照参考文档1,搭建环境. 然后,按照参考文档2,编写插件. 最 ...
- java编写的atm机项目结题报告_java编写的atm机项目结题报告.docx
java编写的atm机项目结题报告 java编写的atm机项目结题报告 篇一:java自动取款机模拟程序报告含源代码 合肥学院 计算机科学与技术系 课程设计报告 XX-XX学年第一学期 课学学专指 业 ...
- markdown编写Python简历模板
#1024程序员节 勋章听说很帅啊! markdown编写Python简历模板 ... 等我整理放上来,先占个坑... ...
最新文章
- silverlight后台加载本地图片
- linux mysql 知乎_在 Linux 上安装 MariaDB 或 MySQL | Linux 中国
- Flutter中Row中的子控件左右两端对齐
- 关于安装oracle 11G R2 for Windows X64问题
- 源码编译依赖关系一例小结
- 「Vueconf」探索 Vue3 中 的 JSX
- flutter 国际化_从0开始设计Flutter独立APP | 第二篇: 完整的国际化语言支持
- xpwifi热点设置android,教你在XP电脑中开启设置WiFi热点使用的步骤
- pythonsql注入步骤_防止SQL注入解决方案
- Centos8 cmake运行失败 undefined symbol archive_write_add_filter_zstd
- python1000行代码_用好这3行代码,可以让你的Python脚本速度提升5倍!
- linux操作系统使用论文_Linux学习2 使用VirtualBox安装国产深度操作系统
- MPLS(多协议标记交换)协议能否降低跨省组建企业专网的成本?
- 基于 Flink 的典型 ETL 场景实现方案
- 关于输入法图标消失 只能输入英文 win10 语言选项 键盘那里显示 输入法仅桌面的解决办法
- 手机重装为linux,安卓手机重装系统的方法
- win10计算机管理中没有本地用户和组怎么办
- pl330 dmac驱动分析2----关键函数
- php浏览器跟踪调试,Phpstorm怎么在命令行以及浏览器中调试
- 企业IT咨询和信息化规划方法
热门文章
- 项目管理工具_Project 基础教程
- TurboMail邮件系统配置之预防邮件炸弹
- 常用命令和常用工作地址管理工具
- 2019中国互联网应用基本发展状况
- jQuery实现下拉菜单[代码+详细讲解+效果图]
- STM32L452CCU6 STM32L432KCU6 GD32F407VKT6 嵌入式技术数据手册 32位ARM
- 《淘宝技术这十年》简评
- swift中swiftNotice的pleaseWait()方法
- 如何将word图片粘贴到动易CMS里面
- linux磁盘刻录ISO工具,技术|Ubuntu下的三个好用的CD/DVD刻录工具