有什么类似github book的WEB文档手册?

最近要做个类似微信等各大平台的开发者文档,github book 基本满足需求,但是想把文件放在自己的服务器。

  1. 有没有可以本地编辑然后能导出html 格式的?最好是markdown编辑
  2. 最终要能导出类似github book的整站 开发者文档
阅读 4.7k
3 个回答

你是想说gitbook吗?

npm install gitbook -g

你的需求我以前弄过,最后用asciidoc语法实现了。

理由:

  1. 相比markdownasciidoc支持更多标记语法,可以实现更多文档特效

  2. asciidoc本身支持样式,可以写出漂亮格式的语法文档。这个和无样式的markdown不同

  3. 很多语法非常类似于markdown,对于熟悉markdown的用户来说,非常容易上手

  4. 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 //输出错误信息
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进