文档工具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,从原子列到消除依赖,层层递进,提升数据一致性与可维护性,让数据库设计更高效、安全!#数据库 #范式设计
2745 0
|
Web App开发 域名解析 缓存
如何在 Ubuntu 20.04 上安装 Node.js 和 npm
本文我们主要为大家介绍在 Ubuntu 20.04 上安装 Node.js 和 npm 的三种不同的方式。
169981 7
如何在 Ubuntu 20.04 上安装 Node.js 和 npm
|
Java Android开发 p3c
Alibaba Java Coding Guidelines安装使用教程
Alibaba Java Coding Guidelines安装使用教程
12383 0
Alibaba Java Coding Guidelines安装使用教程
IDEA 使用 lombak 时的一个小警告:Generating equals/hashCode implementation but without a call to superclass
今日在IDEA中使用Lombok时遇到@Data注解的黄色警告,提示equals和hashCode未调用父类方法。虽不影响运行,但影响美观。可通过@EqualsAndHashCode(callSuper = true)或在lombok.config中配置默认行为解决,推荐后者统一管理,彻底消除警告。
|
文字识别 网络协议 开发工具
GitHub封锁?推荐5个国产的Git仓库替代平台
近日,GitHub对中国区IP的部分限制引发了广泛关注。未登录用户被拒,已登录用户功能受限,南北网络环境差异更显“内卷”。为应对这一挑战,本文推荐了多个国产Git平台:Gitee(码云)、GitCode(CSDN旗下)、CODING(腾讯系)、CodeUP(阿里云支持)及微信代码管理工具。这些平台功能全面、稳定性强,是开发者迁移项目的理想选择。通过同步代码、配置CI/CD流水线等简单步骤,可确保项目平稳过渡。此次事件提醒我们,掌握核心技能与支持国产平台同样重要!
12021 11
|
Kubernetes 网络虚拟化 Docker
K8S镜像下载报错解决方案(使用阿里云镜像去下载kubeadm需要的镜像文件)
文章提供了一个解决方案,用于在无法直接访问Google镜像仓库的情况下,通过使用阿里云镜像来下载kubeadm所需的Kubernetes镜像。
1802 4
K8S镜像下载报错解决方案(使用阿里云镜像去下载kubeadm需要的镜像文件)
ELK 圣经:Elasticsearch、Logstash、Kibana 从入门到精通
ELK是一套强大的日志管理和分析工具,广泛应用于日志监控、故障排查、业务分析等场景。本文档将详细介绍ELK的各个组件及其配置方法,帮助读者从零开始掌握ELK的使用。
|
Linux 开发工具 数据安全/隐私保护
搭建 Git 私人服务器完整指南
本文详细介绍了如何从零开始搭建一个私人的 `Git` 服务器。首先,文章解释了 `Git` 的概念及其优势,并阐述了搭建私人 `Git` 服务器的重要性,包括数据隐私、定制化需求及成本效益。接着,文章分步骤指导读者完成服务器的准备工作,包括操作系统、硬件和网络要求。随后,详细介绍了在不同操作系统上安装 `Git` 的方法,并演示了如何创建 `git` 用户、部署仓库以及设置免密登录。此外,还提供了客户端连接远程仓库的具体步骤,包括 Linux 和 Windows 的操作方式。最后,文章探讨了迁移仓库的方法以及搭建 `Git` 服务器的一些进阶选项。
6652 0
搭建 Git 私人服务器完整指南

热门文章

最新文章

下一篇
开通oss服务