1.33.2.1. Gitbook
1.33.2.1.1. Gitbook介绍
Setup and Installation of GitBook
1.33.2.1.2. Gitbook使用
- 安装 GitBook:npm i gitbook-cli -g
- 初始化 GitBook 项目:gitbook init
- 安装 GitBook 依赖:gitbook install
- 打包 GitBook 项目:gitbook build
- 开启 GitBook 服务:gitbook serve
- GitBook 命令行查看:gitbook -help
- GitBook 版本查看:gitbook -V
我们在 终端 输入 gitbook serve 即可开启一个 localhost:4000 的服务,请在浏览器中输入 http://localhost:4000 即可访问服务。
生成电子书
GitBook 可以生成一个网站,但也可以输出内容作为电子书(ePub,Mobi,PDF)。
# Generate a PDF file
$ gitbook pdf ./ ./mybook.pdf
# Generate an ePub file
$ gitbook epub ./ ./mybook.epub
# Generate a Mobi file
$ gitbook mobi ./ ./mybook.mobi
1.33.2.1.3. Gitbook配置
book.json配置
基本信息、links、plugins、pluginsConfig等
gitbook使用教程
使用Git进行控制,并把项目托管到 GitBook.com(二)
GitBook 简明教程
book.json部分配置参考
{
"title": "Kubernetes",
"description": "Kubernetes ",
"language": "zh-hans",
"author": "Jimmy",
"plugins": [
"page-toc-button",
"back-to-top-button",
"image-captions",
"-lunr",
"-search",
"search-plus",
"-highlight",
"prism",
"prism-themes",
"sitemap-general"
],
"pluginsConfig": {
"image-captions": {
"caption": "图 _PAGE_LEVEL_._PAGE_IMAGE_NUMBER_:_CAPTION_"
},
"prism": {
"css": [
"prism-themes/themes/prism-ghcolors.css"
]
},
"sitemap-general": {
"prefix": "https://jimmysong.io/kubernetes-handbook/"
}
}
}
1.33.2.1.4. Gitbook插件
可以在 plugins.gitbook.com 查找或者在 NPM 或者 Github 上找插件。
Gitbook 的插件在 NPM 上都是以 gitbook-plugin 开头的,很容易查找的。