html - 求帮助文档编写工具

查看:79
本文介绍了html - 求帮助文档编写工具的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

问 题

我的问题:
我想找到一个工具,能够像hexo那样用markdown来编写文章,然后生成html文档。
由于项目开发需要编写软件帮助文档(需要在本机打开html页面就能看到),但是不想用office word来写。
目标是想做一个spring、spring boot那样的html文档。
直接试了一下hexo,但是生成的html内容需要部署到服务器才能访问。
各位有什么好工具推荐吗?

spring boot的文档是这样子的:

解决方案

写官方帮助文档最合适的工具就数asciidoc了。相比markdown支持更丰富的格式,甚至连图标都能支持,还支持部分数学公式。相比LaTex要更简单。如果你想书写比markdown更加规范的帮助文档,那么asciidoc可能是你的选择。

和markdown同样属于标记性文档,易学易上手,标记比markdown多,生成的排版更加规范。

如果你只是想生成一个github项目那种README文档的话,可能markdown就足够了,因为它标签足够少,够简单

这篇关于html - 求帮助文档编写工具的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆