文档写作

公司项目要写一个帮助文档,我就想要用Markdown来做

原本

原本的项目是用doc来管理帮助文档的。用的是Office 2010自带的另存为 Html ……功能,加上cssJavaScript,做的网页版联机帮助

存在的问题就是不好管理,版本和版本之间没有办法对比。

Markdown 实现

个人比较喜欢用Markdown来写东西,要不然就要直接手写html网页了。

要求

要求比较简单,大致就是doc那些功能都实现就好

  • 页面插图
  • 生成目录
  • 点击目录可以直接跳转

尝试实现

Markdown用的vscode。本身的预览基本符合要求,生成目录有插件可以搞定,这个问题不大,关键在于vscode不提供导处预览页面的功能,只能去寻找插件实现。

在市场了基本找遍了所有MarkdownHtml的插件,大部分都不能实现点击目录跳转的功能。最接近的一个是可以实现跳转,但是不支持中文。简直绝望。

后来找到了一个js库i5ting_ztree_toc可以用来方便地生成侧边目录。符合上面列出的所有要求。

这个,通过Markdown生成页面大致的操作入下:

  1. 通过插件生成不带目录的页面
  2. 在页面上添加i5ting_ztree_toc
  3. 添加自己的css调整

最后用的

最后用的时候,前端说他们有实现doc转页面的工具,那我就不管了。

后来看看,用的工具需要手动调整排序……

还不如用我的方法