使用Gitbook生成电子书

embedded/2024/10/19 9:06:37/

背景

  《Google工程实践文档》相对原文Google’s Engineering Practices documentation ,部分内容过时了。需要更新中文版,并使用Gitbook把Markdown文件转换成对应的PDF电子书
  上一次生成PDF电子书是5年前,当时生成电子书的环境早已不在。此次重新搭建环境,以备忘。

工具

  需要安装3个工具:Calibre、nvm 和nodejs。

  1. Calibre
    使用Gitbook生成PDF文件时,底层会调用Calibre生成PDF文件。
  2. nvm
    用于管理nodejs版本。
    本机已经是最新版本的nodejs(版本号20.11.0)。由于gitbook官方长期未更新,与最新版本的nodejs不兼容。为了让其正常运行,本机只能安装较老版本(10.22.0)的nodejs。
    安装nvm的目的是为了随时能在不同的nodejs版本间切换。当需要使用gitbook时,使用10.22.0,否则,其他场合使用最新版本。
  3. Nodejs和gitbook
    Gitbook命令基于nodejs(版本号10.22.0)运行。

安装步骤

1. 安装Calibre
  Calibre 必须使用3.48版本。
  最新版本的Calibre虽然也能生成PDF文件,但兼容性不好,生成的PDF文件比较大,而且会内嵌很多字体。除此之外,在生成的PDF文件中,电子目录(左边的书签)无法正确定位到文档中正确的位置。
  在官网:Previous calibre releases 可以找到 3.48 版本。
  下载后,双击安装。

2. 安装nvm
 1) 从Github上下载windows版安装文件 nvm-setup.exe 。
  下载链接:https://github.com/coreybutler/nvm-windows/release 。
  安装过程中,会提示找到已安装的版本,是否要纳入版本管理,点击“是”。
 2) 安装nvm之后,到命令行中执行  
  $ nvm npm_mirror https://registry.npmmirror.com
 3) 安装 10.22.0 版本的nodejs,运行
  $ nvm install 10.22.0
 4) 切换到版本 10.22.0,运行
  $ nvm use 10.22.0
 5) 运行 node -v,运行结果显示
  $ node –v
  v10.22.0

3. 安装gitbook并验证版本为3.2.3
  $ npm install gitbook-cli –g
  $ gitbook –v
  CLI version: 2.3.2
  GitBook version: 3.2.3

运行流程

  Gitbook生成电子书的流程如下图所示:

生成PDF电子书

  1. 下载电子书到本地。
  2. 进入电子书目录,运行 gitbook pdf ./ ./Google工程实践文档.pdf

  运行help命令可以查询gitbook的用法。
    $ gitbook help
    build [book] [output]       build a book
        –log                   Minimum log level to display (Default is info; Values are debug, info, warn, error, disabled)
        –format                Format to build to (Default is website; Values are
    ……

参考资料


http://www.ppmy.cn/embedded/28558.html

相关文章

算法学习(5)-图的遍历

目录 什么是深度和广度优先 图的深度优先遍历-城市地图 图的广度优先遍历-最少转机 什么是深度和广度优先 使用深度优先搜索来遍历这个图的过程具体是: 首先从一个未走到过的顶点作为起始顶点, 比如以1号顶点作为起点。沿1号顶点的边去尝试访问其它未…

在一台交换机上配置VLAN

实验环境 实验拓扑图结构如图12.12所示,其中PC1和PC3属于VLAN 2,PC2属于 VLAN 3,PC1的IP地址为192.168.0.2/24,PC2的IP地址为192.168.1.2/24,PC3的 IP地址为192.168.0.3/24。 图12.12 需求描述 要求处于相同VLAN中的主…

Armpro脱壳软件搭建教程附源代码

PHP8.0版本,数据库8.0版本 1.配置注册机文件,打开将arm.zip/res目录下,mt管理器搜索将其全部修改为你自己的域名或者是服务器IP 2.然后建立数据库 数据库账号arm 数据库用户名arm 数据库密码EsZfXY4tD3h2NNA4 3.导入数据库 4.配置Redi…

什么是DTU和串口服务器的区别

在工业物联网的快速发展中,数据传输单元(DTU)和串口服务器作为两种关键设备,各自扮演着重要的角色。对于传统行业来说,了解它们的基本概念和区别,有助于更好地选择和应用这些技术,提升生产效率和…

机器学习是啥?

1.深度学习是啥? 深度学习(Deep Learning)是机器学习(Machine Learning)的一个子领域,它基于神经网络(Neural Networks)的学习算法。深度学习致力于模拟人脑进行分析学习的神经网络…

Golang使用自定义IP请求https

可以自定义 TLSClientConfig 的 ServerName 字段,并使用自定义的 DialContext 函数来控制连接到指定 IP 代码如下 func main() {// 定义目标站点的域名和IP地址domain : "www.baidu.com"ip : "183.2.172.42" // 该 IP 地址对应 baidu.com// 创…

【Go语言快速上手(六)】管道, 网络编程,反射,用法讲解

💓博主CSDN主页:杭电码农-NEO💓   ⏩专栏分类:Go语言专栏⏪   🚚代码仓库:NEO的学习日记🚚   🌹关注我🫵带你学习更多Go语言知识   🔝🔝 GO快速上手 1. 前言2. 初识管道3. 管…

如何处理微服务之间的通信和数据一致性?

✨✨祝屏幕前的兄弟姐妹们每天都有好运相伴左右,一定要天天开心哦!✨✨ 🎈🎈作者主页: 喔的嘛呀🎈🎈 目录 引言 一、微服务通信 1、同步通信:HTTP 1.1.同步通信示例代码&#x…