Gitbook

2017年9月13日 17:12:20 星期三

gitbook 可以将markdown格式的文件编译成html格式 放在当前目录里的_book目录里(需要手动创建, 也可以指定编译后的html文件放到哪里)

它有几个文件需要注意:

SUMMARY.md: 用markdown格式书写的目录 (常用 *, +, - 开头表示无序列表)

book.json: 这里边是配置, 作者, 标题什么的, 比较重要的是插件, 这里边的插件是要用 命令 (gitbook install) 来安装的, 安装的插件存放在当前目录的(node_modules)

有几个工具需要注意:

node.js(npm):  用来下载安装gitbook相关工具

gitbook: npm install gitbook;  用来安装插件(写接口文档的话, 推荐tree这个插件)

gitbook-cli: npm install gitbook -g ;  用来编译md文件成html文件; 也可以生成一个本地的服务器, 用来访问生成的html

gitbook-editor: 用来更方便的编辑md文件, 导入的时候是复制一份本地md文档到它的默认目录, 然后在此副本上修改,

　　最后publish的时候会覆盖当前目录, 但最后编译还是用命令的好, 有时候有的插件安装后会有很多级的目录, 导致保存, 同步出错,总之奇奇怪怪的问题很多

 

gitbook插件: https://plugins.gitbook.com/  (有一些是这里找不到的, 可以通过 gitbook install 配合book.json 安装)

gitbook-cli用法: https://www.npmjs.com/package/gitbook-cli

gitbook editor+github用法: http://blog.csdn.net/hk2291976/article/details/51173850

 

注意:

gitbook最新版本(2017-9-14)编译速度比较慢, 我们接口md文件有600+, 编译要20多分钟.....

 

PHP解析markdown:    https://github.com/SegmentFault/HyperDown

js解析markdown:  https://github.com/SegmentFault/HyperDown.js