文档工具GitBook使用指南

简介: 这篇博客提供了GitBook的安装和使用指南,包括如何在本地安装Node.js和GitBook、初始化GitBook项目、生成HTML和电子书格式(PDF、mobi)的文档,以及推荐的相关阅读资源。

作者:尹正杰
版权声明:原创作品,谢绝转载!否则将追究法律责任。

一.安装Gitbook

1>.安装nodejs

  较新版本的gitboot关于左侧导航栏使用了ajax技术,导致使用gitboot必须得基于HTTP协议,它不像旧版本默认支持本地文件访问,即不能双击打开Markdown文件,因此本篇博客安装的nodejs版本偏低。

  nodejs下载地址:
    https://nodejs.org/download/release/v6.14.1/

2>.安装Gitbook

C:\Users\yinzhengjie>npm install -g gitbook-cli          #安装nodejs成功后,就可以直接在线安装Gitbook啦~

在安装Gitbook的时候,可能会出现如下图所示的情况,这个时候可以考虑降低Gitbook的版本,即可成功,操作方法如下。
  npm config set registry https://registry.npm.taobao.org/
  gitbook uninstall 3.2.3
  gitbook fetch 3.0.0

如果你有VPN的话应该不会遇到和我一样尴尬的情况,可以更换回npm官方仓库源,操作如下所示:
  npm config set registry http://www.npmjs.org
温馨提示:
  可以使用"npm config list"查看当前nodejs管理工具的配置信息哟~

3>.查看Gitbook的帮助信息

C:\Users\yinzhengjie>gitbook -V

二.Gitbook的基本使用

1>.初始化GitBook

D:\yinzhengjie\gitbook>gitbook init        #如下图所示,在你操作系统中选择相应的路径执行改命令,可以进行Gitbook的初始化操作  


温馨提示:  
  如下图所示的两个文件可不是平白无故生成的,他们都有各自的作用:  
    SUMMARY.md:  
      目录总纲,即里面只记录目录对应的文件名称,并不存储真实数据。  
    README.md:  
      用于介绍的文件。  

  上面介绍了2个文件的作用,您打开SUMMARY.md文件会发现默认就有对README.md的映射关系,推荐您在初始化目录后,新建一个文件目录用来专门存储您的笔记,而后使用SUMMARY.md映射对应的Markdown文件即可。

2>.生成HTML文档

D:\yinzhengjie\gitbook>gitbook -V
CLI version: 2.3.2
GitBook version: 3.0.0

D:\yinzhengjie\gitbook>
D:\yinzhengjie\gitbook>gitbook build --gitbook=3.0.0      #编译时指定Gitbook版本。需要注意的是,指定Gitbook版本要与安装的版本一致,否则他默认会去下载最新的Gitbook版本后再进行编译操作。

3>.生成PDF和mobi电子书

想要转换成PDF以及mobi格式,需要我们单独安装Calibre软件。  

终端进入文档目录执行以下命令:  
  gitbook pdf  
  gitbook mobi  

电子书封面图片:  
  将图片重命名为cover.jpg放到电子书项目目录即可,同事需要注意以下几项:  
    (1)图片大小上线1800*2360像素;  
    (2)没有边框;  
    (3)清晰可见的书本标题;  
    (4)任何重要的文字在小版本中应该可见;

三.博主推荐阅读

    GitBook v3.2.3 使用教程
      https://www.bookstack.cn/read/gitbook-use-3.2.3/introduction.md
  标记语言MarkDown快速入门篇
    https://developer.aliyun.com/article/1604449
目录
相关文章
|
安全 数据库 存储
数据库设计基石:一文搞懂 1NF、2NF、3NF 三大范式
数据库设计常遇数据冗余、增删改异常?根源往往是表结构不规范。本文带你轻松掌握数据库三大范式——1NF、2NF、3NF,从原子列到消除依赖,层层递进,提升数据一致性与可维护性,让数据库设计更高效、安全!#数据库 #范式设计
4499 0
|
安全 网络安全 API
163邮箱IMAP服务器设置方法
```markdown 使用IMAP协议同步163邮箱:登录邮箱→设置→账户→IMAP/SMTP→开启服务→配置服务器(imap.163.com:993, SSL/TLS)→设置用户名和密码→保存并在邮件客户端添加账号。确保多设备邮件同步,定期更新设置。[≤240字符] ```
|
开发工具 git
解决:‘git‘ 不是内部或外部命令,也不是可运行的程序
解决:‘git‘ 不是内部或外部命令,也不是可运行的程序
解决:‘git‘ 不是内部或外部命令,也不是可运行的程序
|
机器学习/深度学习 人工智能 数据可视化
生成AI的两大范式:扩散模型与Flow Matching的理论基础与技术比较
本文系统对比了扩散模型与Flow Matching两种生成模型技术。扩散模型通过逐步添加噪声再逆转过程生成数据,类比为沙堡的侵蚀与重建;Flow Matching构建分布间连续路径的速度场,如同矢量导航系统。两者在数学原理、训练动态及应用上各有优劣:扩散模型适合复杂数据,Flow Matching采样效率更高。文章结合实例解析两者的差异与联系,并探讨其在图像、音频等领域的实际应用,为生成建模提供了全面视角。
3862 1
生成AI的两大范式:扩散模型与Flow Matching的理论基础与技术比较
|
机器学习/深度学习 算法 测试技术
深度学习环境搭建笔记(二):mmdetection-CPU安装和训练
本文是关于如何搭建深度学习环境,特别是使用mmdetection进行CPU安装和训练的详细指南。包括安装Anaconda、创建虚拟环境、安装PyTorch、mmcv-full和mmdetection,以及测试环境和训练目标检测模型的步骤。还提供了数据集准备、检查和网络训练的详细说明。
1362 5
深度学习环境搭建笔记(二):mmdetection-CPU安装和训练
|
文字识别 网络协议 开发工具
GitHub封锁?推荐5个国产的Git仓库替代平台
近日,GitHub对中国区IP的部分限制引发了广泛关注。未登录用户被拒,已登录用户功能受限,南北网络环境差异更显“内卷”。为应对这一挑战,本文推荐了多个国产Git平台:Gitee(码云)、GitCode(CSDN旗下)、CODING(腾讯系)、CodeUP(阿里云支持)及微信代码管理工具。这些平台功能全面、稳定性强,是开发者迁移项目的理想选择。通过同步代码、配置CI/CD流水线等简单步骤,可确保项目平稳过渡。此次事件提醒我们,掌握核心技能与支持国产平台同样重要!
19400 11
|
运维 数据可视化 安全
AR增强现实应用于工业4.0的5个案例研究
增强现实(AR)正重塑工业流程,通过实时可视化与数据叠加,提升效率、安全与质量。本文介绍AR在设备维护、汽车制造、质量控制及航空等领域的应用案例,展现其如何助力企业优化操作、减少错误并提升培训效果,推动智能化升级。
|
JavaScript 内存技术
nvm安装教程与nvm常见命令,超详细!
nvm安装教程与nvm常见命令,超详细!
10464 107
|
算法 测试技术 Go
Go 1.24.0 重磅发布:新特性、新工具,开发者必看!
`Go 1.24.0` 已正式发布,带来诸多改进和新特性。语言层面上,泛型类型别名现已被完全支持;性能方面,通过优化 `map` 实现和内存分配,减少了 2-3% 的 CPU 开销;工具链新增模块工具依赖跟踪及测试分析器;标准库增加了弱引用包、FIPS 140-3 合规机制等;WebAssembly 支持也得到了增强。快来下载体验吧!
1003 15