文档工具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
目录
相关文章
|
资源调度 JavaScript 应用服务中间件
VuePress介绍及使用指南
VuePress是一个基于Vue.js的静态网站生成工具,它专注于以Markdown为中心的项目文档。VuePress具有简单易用的特性,同时提供了强大的自定义和扩展性。
202 2
VuePress介绍及使用指南
|
9月前
|
定位技术
MicroStation软件与Terrasolid插件合集的安装方法
MicroStation软件与Terrasolid插件合集的安装方法
105 2
下载文档【报错的小技巧】(了解一下)
下载文档【报错的小技巧】(了解一下)
57 0
|
移动开发 JavaScript 开发工具
less文档和安装
less文档和安装
170 0
|
Java Android开发 数据安全/隐私保护
ApkScan-PKID 查壳工具下载与使用
一、 关于壳的介绍 1、壳的功能:壳最本质的功能就是实现加载器,壳是指在一个程序的外面再包裹上另外一段代码,保护里面的代码不被非法修改或反编译的程序。它们一般都是先于程序运行,拿到控制权,然后完成它们保护软件的任务,深入点就是在apk外面再套一层壳,在运行的时候这层壳会把真正的apk的dalvik指令集释放出来,为apk加壳是目前主流的防护方案,真正的源码是隐藏在壳之下的,要想拿到源码研究其逻辑就
819 0
ApkScan-PKID 查壳工具下载与使用
|
JavaScript Ubuntu
gitbook 快速入门
gitbook 快速入门
gitbook 快速入门
SVN 入门使用指南
在开发的过程中版本控制器是必不可少的工具,方便对相对资源回滚提交等相关节点查找 SVN安装程序下载 下面介绍一下先关软件的入门使用 第一步安装软件 下载上面提供的下载地址,会有两个安装文件,一个数主程序安装包,一个是汉化包,其实无脑下一步就可以了 首先安装TortoiseSVN-1.
931 0
|
JavaScript API
Docsify使用指南(打造最快捷、最轻量级的个人&团队文档)
Docsify使用指南(打造最快捷、最轻量级的个人&团队文档)
1379 0
Docsify使用指南(打造最快捷、最轻量级的个人&团队文档)
|
机器人
gitbook 插件 阅读更多
gitbook 插件 阅读更多
|
存储 机器学习/深度学习 数据可视化
DVC 使用指南:与相关技术进行比较
DVC 将许多现有的想法结合到一个工具中,目标是将软件工程的最佳实践带入数据科学领域。

热门文章

最新文章