Gitbook 使用笔记

2022-06-15 09:57:34 浏览数 (1)

安装

  1. 首先需要安装Node.js,安装教程见Windows 下 Node.js 的安装(多图版)
  2. 确认Node.js安装好之后,使用如下命令安装gitbook
代码语言:javascript复制
npm install -g gitbook-cli

安装好之后,利用如下命令查看版本;

代码语言:javascript复制
gitbook -V

常用命令

命令

功能

gitbook init

初始化目录文件

gitbook help

列出gitbook所有命令

gitbook --help

列出gitbook-cli的帮助信息

gitbook build

生成静态网页

gitbook build --gitbook={version}

生成时指定gitbook版本

gitbook build --log=debug

指定log级别

gitbook build --debug

输出错误信息

gitbook serve

生成静态网页并允许服务器

gitbook ls

列出本地所有gitbook版本

gitbook ls-remote

列出远程可用的gitbook版本

gitbook fetch {tag/version}

安装对应gitbook版本

gitbook update

更新到最新版本

gitbook uninstall {version}

卸载对应版本gitbook

目录结构

​一开始图书文件夹下为空,我们使用命令行工具,就会自动创建README.mdSUMMARY.md

代码语言:javascript复制
gitbook init
  1. 而上一步中文件夹下生成的两个文件是图书必须具备的两个文件,我们可以对其修改:
  • README.md:对当前图书的简介,即该图书的大概摘要。
代码语言:javascript复制
  # LeetCode题集

  - 目的: 整理自己在LeetCode的解题思路;
  - 使用语言: `Java`

SUMMARY.md:即本书的目录结构;

代码语言:javascript复制
  # Summary

  - [Introduction](README.md)

  - [Array](Array/README.md)
      - [LeetCode 1. 两数之和](Array/LeetCode 1. 两数之和.md)

  - [String](String/README.md)
      - [LeetCode 58.最后一个单词的长度](String/LeetCode 58.最后一个单词的长度.md)

创建并修改 README.mdSUMMARY.md 之后,再次使用命令行工具就会按SUMMARY.md给定的目录结构生成相应目录及文件;

代码语言:javascript复制
gitbook init

此时生成的目录及文件树如下:

代码语言:javascript复制
.
│  README.md
│  SUMMARY.md
│  
├─Array
│      LeetCode 1. 两数之和.md
│      LeetCode 1.两数之和.md
│      README.md
│      
└─String
        LeetCode 58.最后一个单词的长度.md
        README.md

相关配置

  1. 常用的一些配置信息如下:
  1. structure对应变量名及默认值

输出图书

​目前GitBook支持生成如下格式的图书:

  • PDF
  • eBook
  • JSON
  • 单个 HTML
  • 静态 HTML(可当做静态网站)

静态 HTML 生成

  • 当对图书文档编辑好之后,可用如下命令在本地进行预览,默认会启动本地的4000端口; gitbook serve ./{book_name}

在浏览器中访问http://localhost:4000/即可访问如下页面;

  • 使用如下命令行工具,即可将内容输出到指定目录;
代码语言:javascript复制
   gitbook build --output={path}
  ```

  ![image](https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy85NzQ3MzUwLTM3MDY4N2RkNjJhMTdjZTUucG5n?x-oss-process=image/format,png)

  生成的文件如下图所示,此时就可以将这些静态`HTML`打包部署到服务器或者发送给读者:

  ![image](https://imgconvert.csdnimg.cn/aHR0cHM6Ly91cGxvYWQtaW1hZ2VzLmppYW5zaHUuaW8vdXBsb2FkX2ltYWdlcy85NzQ3MzUwLTZkYjkzNjRmYjc5MTQ2MjAucG5n?x-oss-process=image/format,png)

生成mobi

切换到要生成的图书文件夹下,使用如下命令行工具即可生成mobi格式文件;

代码语言:javascript复制
gitbook mobi

生成pdf

  • 切换至要生成的图书文件夹下,使用如下命令行工具即可生成pdf格式文件; gitbook pdf

注意:转换时可能会出现如下错误,此需要安装calibre,然后重启命令行重新执行此命令即可;

代码语言:javascript复制
 EbookError: Error during ebook generation: 'ebook-convert' is not recognized as an internal or external command operable program or batch file

常见PDF导出参数

生成epub

切换至要生成的图书文件夹下,使用如下命令行工具即可生成epub格式文件;

代码语言:javascript复制
gitbook epub

0 人点赞