book.json
新建一个 book.json 文件,可以配置网站信息、在 plugins 和 pluginsConfig 字段添加插件等。
插件命名方式为:
gitbook-plugin-X: 插件;
gitbook-theme-X: 主题。
預設安裝的Plugins
GitBook 預設有安裝7個plugins:
- highlight
- search
- lunr
- sharing
- fontsettings
- livereload
- theme-default
如果要在Gitbook內移除預設安裝的plugin
要在book.json
內的"plugins"
中,加上寫上-套件名稱
(前面加上負號)
舉例來說,要移除search plugin的話會這樣寫:
"plugins": ["-search"]
如果想配置直接在 pluginsConfig 配置
由於章節號在新版的Gitbook被關起來了,要打開的話要在pluginsConfig
加入下列的json
TOC number is disabled by default,add this to active it
"pluginsConfig": {
"theme-default":{
"showLevel":true
}
}
為左邊的slide bar上面加上Home選項
在book.json文件中,添加links配置项:
"links" : {
"sidebar" : {
"Home" : "http://yangzh.cn"
}
}
打算寫的plugin
https://www.npmjs.com/package/gitbook-plugin-etoc-plus
https://www.npmjs.com/package/gitbook-plugin-multipart
https://www.npmjs.com/package/gitbook-plugin-codeblock-filename
- ,在文档中增加交互练习内容,目前只支持js语言。
- quiz ,在文档中增加测验内容,支持单选、多选、排序。
- include-codeblock ,使得GitBook能引用外部独立文档。
- localized-footer ,为GitBook的每个页面添加页脚内容。
- search-pro ,为GitBook添加多字节字符搜索,实现中文搜索(默认只能搜索英文)。
- sharing-plus ,GitBook默认分享工具的增强版,加入了中国常用的社交网站。
- changyan ,为GitBook页面添加畅言评论框。
- iframely , 在页面中嵌入常见视频网站内容。
- bibtex-indexed-cite ,使用bibtex格式,自动生成参考文献。
Reference
https://ymcatar.gitbooks.io/gitbook-test/content/testing_mcqx.html