最近要做个类似微信等各大平台的开发者文档
,github book 基本满足需求,但是想把文件放在自己的服务器。
- 有没有可以本地编辑然后能导出html 格式的?最好是markdown编辑
- 最终要能导出类似github book的整站 开发者文档
最近要做个类似微信等各大平台的开发者文档
,github book 基本满足需求,但是想把文件放在自己的服务器。
- 有没有可以本地编辑然后能导出html 格式的?最好是markdown编辑
- 最终要能导出类似github book的整站 开发者文档
你的需求我以前弄过,最后用asciidoc
语法实现了。
理由:
相比markdown
,asciidoc
支持更多标记语法,可以实现更多文档特效
asciidoc
本身支持样式,可以写出漂亮格式的语法文档。这个和无样式的markdown
不同
很多语法非常类似于markdown,对于熟悉markdown的用户来说,非常容易上手
markdown本身是提供html的转换,但是asciidoc内置就提供html,pdf等多种文档的生成,甚至还能生成man
手册
总之,README
这类的文档用markdown
,因为足够简单。如果你希望生成官方手册,那么可能asciidoc
更适合你。这玩意生成的文档更加标准和规范,并且比LaTex
简单的多。
用gitbook写导出成html扔nginx不就行了,而且gitbook可以在本地跑server模式的
gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令
gitbook --help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
gitbook build --gitbook=2.0.1 //生成时指定gitbook的版本, 本地没有会先下载
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出远程可用的gitbook版本
gitbook fetch 标签/版本号 //安装对应的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //卸载对应的gitbook版本
gitbook build --log=debug //指定log的级别
gitbook builid --debug //输出错误信息
你是想说gitbook吗?