简单demo
-
需要nodejs环境,自行到nodejs官网下载安装,安装成功后如下
$ node -v v12.16.1
$ npm -v 6.13.4
-
安装gitbook-cli
npm install -g gitbook-cli
-
进入建立gitbook的文件夹,执行下面的命令
gitbook init
-
将会生成两个文件
- README.md —— 书籍的介绍写在这个文件里
- SUMMARY.md —— 书籍的目录结构在这里配置
-
加入自己书写的内容,目录结构如下,自己可以根据需要修改
│ README.md │ SUMMARY.md ├─第一章 │ content.md │ README.md │ ├─第三章 │ content.md │ README.md │ └─第二章 content.md README.md
-
配置SUMMARY.md
# Your Book Title - [第一章](第一章/README.md) * [Content](第一章/content.md) - [第三章](第三章/README.md) * [Content](第三章/content.md) - [第二章](第二章/README.md) * [Content](第二章/content.md)
-
如果不想手动写SUMMARY.md,也可以使用命令自动生成(也可以使用book.json文件指定插件)
npm install -g gitbook-summary book sm
-
写好book内容,配置好SUMMARY.md之后就可以在本地预览gitbook了
gitbook serve
进阶
- 根据自己的需要添加插件进行配置,在主目录下添加book.json文件进行配置,详细的博客:https://www.cnblogs.com/mingyue5826/p/10307051.html
{ "title": "demo",//标题 "description": "demo",//文档描述 "language": "zh",//选择编辑的语言环境