Gitbook 使用笔记

简介: Gitbook 使用笔记

安装

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

image.pngimage.png常用命令

命令 功能

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.md和SUMMARY.md;


gitbook init

image.png

  1. 而上一步中文件夹下生成的两个文件是图书必须具备的两个文件,我们可以对其修改:
  • README.md:对当前图书的简介,即该图书的大概摘要。
  # LeetCode题集
  - 目的: 整理自己在LeetCode的解题思路;
  - 使用语言: `Java`

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

  # 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给定的目录结构生成相应目录及文件;

gitbook init



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

.
│  README.md
│  SUMMARY.md
├─Array
│      LeetCode 1\. 两数之和.md
│      LeetCode 1.两数之和.md
│      README.md
└─String
        LeetCode 58.最后一个单词的长度.md
        README.md

相关配置

常用的一些配置信息如下:


字段 功能

title 书本标题

author 书本作者

description 书本描述

language 使用的语言

gitbook 指定gitbook版本

root 指定存放gitbook文件的根目录

links 左侧导航栏添加链接信息

styles 自定义页面样式

plugins 配置使用的插件

pluginsConfig 配置插件属性

structure 指定Readme、Summary、Glossary、Languages对应文件名

structure对应变量名及默认值


变量 含义及默认值

structure.readme README.md

structure.summary SUMMARY.md

structure.glossary GLOSSARY.md

structure.languages LANGS.md

输出图书

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


PDF

eBook

JSON

单个 HTML

静态 HTML(可当做静态网站)

静态 HTML 生成


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


gitbook serve ./{book_name}


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

  • 使用如下命令行工具,即可将内容输出到指定目录;
   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格式文件;

gitbook mobi

image.png生成pdf

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

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


EbookError: Error during ebook generation: 'ebook-convert' is not recognized as an internal or external command operable program or batch file

1

常见 PDF 导出参数


变量 描述

pdf.pageNumbers 是否添加页码,默认true

pdf.fontSize 字体大小,默认12

pdf.fontFamily 字体,默认Arial

pdf.paperSize 页面大小,有'a0', 'a1', 'a2', 'a3', 'a4', 'a5', 'a6', 'b0', 'b1', 'b2', 'b3', 'b4', 'b5', 'b6', 'legal', 'letter'供选择,默认 a4

pdf.margin.top 上边距,默认56

pdf.margin.bottom 下边距,默认56

pdf.margin.right 右边距,默认62

pdf.margin.left 左边距,默认62

生成epub


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


gitbook epub


image.png

目录
相关文章
|
机器学习/深度学习 算法 PyTorch
【PyTorch实战演练】Fast R-CNN中的RoI(Region of Interest)池化详解
【PyTorch实战演练】Fast R-CNN中的RoI(Region of Interest)池化详解
424 1
|
Linux C语言
Linux命令(116)之journalctl
Linux命令(116)之journalctl
610 0
|
6月前
|
人工智能 数据可视化 C++
Math24o:SuperCLUE开源的高中奥数推理测评基准,85.71分屠榜
Math24o是首个针对高中奥林匹克数学竞赛的中文大模型测评基准,采用2024年预赛真题实现自动化评估,为模型数学推理能力提供客观衡量标准。
194 48
Math24o:SuperCLUE开源的高中奥数推理测评基准,85.71分屠榜
|
7月前
|
人工智能 架构师 Java
最高裁95%,只留5% 用AI的,某上市公司全面ai化。你的岗位,AI入侵指数是 多少?多久消失?
本文探讨了AI对不同岗位的冲击及未来趋势,特别提到上美股份大规模裁员以保留能使用AI的员工。文中分析了Java开发、大数据开发、架构师、产品经理等岗位的AI入侵指数,指出高风险和低风险岗位,并建议进入AI入侵指数低的领域如Java+AI+大数据架构师。此外,文章还介绍了尼恩团队的大模型学习资源和面试指导服务,帮助从业者提升技能,应对AI时代的挑战。
|
9月前
|
机器学习/深度学习 人工智能 数据挖掘
《C++数据降维之道:PCA 与 t - SNE 助力信息留存》
在大数据与人工智能时代,数据维度的爆炸式增长给存储、传输和处理带来了巨大挑战。数据降维技术如主成分分析(PCA)和 t-分布随机邻域嵌入(t-SNE)成为关键解决方案。本文探讨了如何在 C++ 中运用这些方法,有效减少数据维度并保留关键信息,为数据分析和机器学习提供支持。
184 19
|
11月前
|
存储 JavaScript 前端开发
深入理解 JavaScript 执行上下文与 this 绑定机制
JavaScript 代码执行时,会为每段可执行代码创建对应的执行上下文,其中包含三个重要属性:变量对象、作用域链、和 this。本文深入剖析了执行上下文的生命周期以及 this 在不同情况下的指向规则。通过解析全局上下文和函数上下文中的 this,我们详细讲解了 this 的运行期绑定特性,并展示了如何通过调用方式影响 this 的绑定对象。同时,文中对箭头函数 this 的特殊性以及四条判断 this 绑定的规则进行了总结,帮助开发者更清晰地理解 JavaScript 中的 this 行为。
732 8
深入理解 JavaScript 执行上下文与 this 绑定机制
|
监控 网络协议 应用服务中间件
【Tomcat源码分析】从零开始理解 HTTP 请求处理 (第一篇)
本文详细解析了Tomcat架构中复杂的`Connector`组件。作为客户端与服务器间沟通的桥梁,`Connector`负责接收请求、封装为`Request`和`Response`对象,并传递给`Container`处理。文章通过四个关键问题逐步剖析了`Connector`的工作原理,并深入探讨了其构造方法、`init()`与`start()`方法。通过分析`ProtocolHandler`、`Endpoint`等核心组件,揭示了`Connector`初始化及启动的全过程。本文适合希望深入了解Tomcat内部机制的读者。欢迎关注并点赞,持续更新中。如有问题,可搜索【码上遇见你】交流。
【Tomcat源码分析】从零开始理解 HTTP 请求处理 (第一篇)
|
10月前
|
Dart UED
在 Flutter鸿蒙next版本 中使用 if 语句和三元表达式进行视图逻辑判断
在 Flutter 开发中,构建动态和响应式的用户界面是核心任务。本文详细探讨了如何使用 if 语句、三元表达式等方法进行视图逻辑判断,并提供了示例代码。通过这些方法,可以根据不同条件动态渲染组件,提高用户体验。文章还强调了保持代码可读性和合理使用匿名函数的最佳实践。
239 2
|
缓存 安全 UED
什么是应用交付网络(ADN)?
【4月更文挑战第9天】
2274 4
|
传感器 网络协议 中间件
Mqtt学习笔记--交叉编译移植(1)
Mqtt学习笔记--交叉编译移植(1)
283 0

热门文章

最新文章