gitbook初识-CFANZ编程社区

文章目录

gitbook初识

1.环境要求

1.1`node`安装参考
1.2 版本检查

2. 安装`gitbook-cli`脚手架工具
3.基本命令使用

3.1 初始化

3.2 启动
3.3 构建
3.4 示例

4. 预览

gitbook初识

使用gitbook开发电子书，本文主要采用gitbook-cli方式进行讲解。

1.环境要求

gitbook-cli是基于node环境的脚手架工具，使用之前必须准备好node环境。

1.1`node`安装参考

基于M1(arm)架构的Node环境：https://blog.csdn.net/qq_38020915/article/details/119542625
[node npm yarn] windows开发环境搭建：https://blog.csdn.net/qq_38020915/article/details/113477569

1.2 版本检查

dingwen@dingdeMacBook-Pro ~ % node -v
v14.17.4
dingwen@dingdeMacBook-Pro ~ % npm -v
6.14.14

2. 安装`gitbook-cli`脚手架工具

# 全局安装脚手架工具
 npm install -g gitbook-cli
 # 检查版本
 gitbook -v

显示版本信息则表示安装成功，出现TypeError: cb.apply is not a function解决办法

3.基本命令使用

3.1 初始化

gitbook init

3.1.1 目录结构

README.md 首页内容
SUMMARY.md 目录文件
_book 存放构建完成后的markdown文件转成的html文件（可独立部署静态资源服务器）
book.json 配置文件（个性化定制、电子书的标题、封面、作者信息等等）
GLOSSARY.md 词汇表（专业名词的详细解释）
LANGS.md 国际化语言配置文件

3.2 启动

gitbook serve

3.3 构建

gitbook build

3.4 示例

# 创建 `gitbook` 演示项目
$ mkdir gitbook-demo

# 初始化项目
$ gitbook init
warn: no summary file in this book 
info: create README.md 
info: create SUMMARY.md 
info: initialization is finished 

# 启动本地服务器
$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed 
info: loading plugin "livereload"... OK 
info: loading plugin "highlight"... OK 
info: loading plugin "search"... OK 
info: loading plugin "lunr"... OK 
info: loading plugin "sharing"... OK 
info: loading plugin "fontsettings"... OK 
info: loading plugin "theme-default"... OK 
info: found 1 pages 
info: found 0 asset files 
info: >> generation finished with success in 1.2s ! 

Starting server ...
Serving book on http://localhost:4000

# 查看当前目录结构
$ tree
.
├── README.md
├── SUMMARY.md
└── _book
    ├── gitbook
    │   ├── fonts
    │   │   └── fontawesome
    │   │       ├── FontAwesome.otf
    │   │       ├── fontawesome-webfont.eot
    │   │       ├── fontawesome-webfont.svg
    │   │       ├── fontawesome-webfont.ttf
    │   │       ├── fontawesome-webfont.woff
    │   │       └── fontawesome-webfont.woff2
    │   ├── gitbook-plugin-fontsettings
    │   │   ├── fontsettings.js
    │   │   └── website.css
    │   ├── gitbook-plugin-highlight
    │   │   ├── ebook.css
    │   │   └── website.css
    │   ├── gitbook-plugin-livereload
    │   │   └── plugin.js
    │   ├── gitbook-plugin-lunr
    │   │   ├── lunr.min.js
    │   │   └── search-lunr.js
    │   ├── gitbook-plugin-search
    │   │   ├── lunr.min.js
    │   │   ├── search-engine.js
    │   │   ├── search.css
    │   │   └── search.js
    │   ├── gitbook-plugin-sharing
    │   │   └── buttons.js
    │   ├── gitbook.js
    │   ├── images
    │   │   ├── apple-touch-icon-precomposed-152.png
    │   │   └── favicon.ico
    │   ├── style.css
    │   └── theme.js
    ├── index.html
    └── search_index.json

11 directories, 27 files
$