Gitbook使用教程

GitBook安装

GitBook是一个能将使用 Markdown 语法，快速制作成各种格式电子书的工具。它是一个基于 Node.js 的命令行工具，可以用来制作精美的电子书。首先我们得下载Nodejs并安装

注意: 截止到目前的 Gitbook V3.2.3版本，需要使用NodeJs的v10+版本，否则会产生各种报错。

这里建议下载v10.23.1版本，官网最新版本我试了也是不行的。

先安装Nodejs

nodejs历史版本下载连接 https://nodejs.org/zh-cn/download/releases/，下载好了直接下一步安装即可。

安装好了nodejs之后，输入命令检查是否安装成功。如果命令无效，检查一下环境变量是否配置。

$ node -v
v10.24.0

安装GitBook

接下来使用npm命令安装gitbook-cli。它是在同一系统上安装和使用多个版本的GitBook的实用程序。它将自动安装所需版本的GitBook程序。（可能需要一些时间，耐心等待就行）

$ npm install gitbook-cli -g

通过gitbook -V命令查看是否安装成功（可能需要一些时间，耐心等待就行）。V是大写的

$ gitbook -V

Gitbook基本使用

GitBook 基本的目录结构如下所示
|- book.json        //电子书的配置文件
|- README.md        //电子书的主要说明文件
|- SUMMARY.md       //电子书的目录
|- chapter-1/       //电子书的章节1文件夹(chapter-1是文件夹名称，可以自定义)|- README.md      //章节1的说明文件|- 文档1.md     //章节下面的小节1|- 文档2.md     //章节下面的小节2
|- chapter-2/       //电子书的章节2文件夹(chapter-2是文件夹名称，可以自定义)|- README.md      //章节2的说明文件|- 文档1.md     //章节下面的小节2|- 文档2.md     //章节下面的小节2

Gitbook初始化

新建一个文件夹如gitbook_test，使用cd命令进入到该文件夹下，在该文件夹下进行初始化。

$ gitbook init

会自动在目录中生成两个文件，一个是主要说明文件，一个是目录文件

使用typora打开SUMMARY.md文件编写目录，格式如下

# Summary
* [教程导读](README.md)
* [day01—环境搭建&快速入门](day01—Java开发环境/README.md)* [环境搭建](day01—Java开发环境/环境搭建.md)* [入门案例](day01—Java开发环境/基础语法.md)* [基础语法](day01—Java开发环境/入门案例.md)* [课后练习](day01—Java开发环境/课后练习.md)
* [day02—类型转换&运算符](day02—类型转换&运算符/README.md)* [类型转换](day02—类型转换&运算符/类型转换.md)* [运算符](day02—类型转换&运算符/运算符.md)* [if语句](day02—类型转换&运算符/if语句.md)* [课后练习](

生成各小节md文件

编写好目录之后，在gitbook_test文件夹下，再次使用gitbook init命令生成个目录中的各小节md文件。

$ gitbook init

编译生成静态网页

将会在gitbook_test目录下生成一个_book文件夹，这就是我们的一个静态站点

$ gitbook build

编译并预览静态网页

先编译生成静态站点，并且开启一个4000端口服务，在浏览器中使用localhost:4000进行访问

$ gitbook serve

Gitbook配置文件

Gitbook有一个配置文件book.json，在该配置文件中可以配置各种插件，来美化页面的显示和交互效果。由于用到的插件比较多，这里我把常用配置和插件已经写好了，直接粘贴即可。

注意：book.json文件，一定要放在根目录下

{"title": "Java入门教程","description": "用最通俗的语言，带你快速走进Java世界的大门","author": "黑马程序员","output.name": "site","language": "zh-hans","gitbook": "3.2.3","root": ".","plugins": ["-lunr","-search","-sharing","-default-theme","search-pro","theme-comscore","splitter","tbfed-pagefooter","expandable-chapters","hide-element","custom-favicon","-highlight","prism","prism-themes","code","sectionx","flexible-alerts","ancre-navigation"],"pluginsConfig": {"tbfed-pagefooter": {"copyright":"Copyright &copy www.itheima.com/javase 2021","modify_label": "该文件修订时间：","modify_format": "YYYY-MM-DD HH:mm:ss"},"hide-element": {"elements": [".gitbook-link"]},"favicon": "favicon.ico","pdf": {"pageNumbers": true,"fontFamily": "Arial","fontSize": 12,"paperSize": "a4","margin": {"right": 62,"left": 62,"top": 56,"bottom": 56}},"page-toc-button": {"maxTocDepth": 2,"minTocSize": 2},"prism":{"css":["prism-themes/themes/prism-darcula.css"]},"sectionx": {"tag": "b"}},"styles": {"website": "styles/website.css","ebook": "styles/ebook.css","pdf": "styles/pdf.css","mobi": "styles/mobi.css","epub": "styles/epub.css"}
}

写好配置文件之后，需要执行命令来安装插件（这里下载插件需要一点时间，耐心等待即可）

$ gitbook install

Gitbook文档编辑

显示模式切换

使用支持markdown语法的编辑器都可以进行编辑，这里建议使用typora。

基本的markdown语法

# 一级标题
## 二级标题
### 三级标题> 引用格式**文本加粗**- 小黑点格式```
此处编写代码
````行内代码`

文档内容折叠效果

如：我们想设置一个课堂提问，但是不想让学生看到答案。可以将答案内容折叠起来效果如下。

在md文件中，按照以下格式写入即可，编译之后的网页就是这种显示效果。

<!--sec data-title="问题1：跨平台中平台指的是什么？" data-id="section1" data-show=true data-collapse=true ces-->Java的跨平台性指的是用Java语言开发的程序可以在多种平台上运行，这里的平台指的是操作系统，常见的操作系统有 **Windows**、**Linux**、**MacOS**<!--endsec-->

注意：data-id的属性值不能你重复，如果一个页面中有多处折叠效果的话。

注意事项效果

如：经常有一些细节问题需要学生注意，需要有一个醒目但又直观的警告效果如下。

在md文件中采用以下格式编写，编译之后页面中显示的就是警告效果

> **[!WARNING] **
> 我们只能说Java程序是跨平台的，但是Java虚拟机不是夸平台的

友情提示效果

如：经常有一些小技巧需要给学生一些建议，可以使用提示效果如下。

在md文件中采用以下格式编写，编译之后页面中显示的就是TIP提示效果

> **[!TIP] **
> 此题能够写出来，说明你已经掌握了 **数值拆分** 这一类文件的解决思路。详细你，可以的

Gitbook发布站点

如果想要你的站点能够在线访问，可以将编译之后生成的_book文件夹，推送到github上，或者gitee上进行托管，并开启Page服务。

注意：github由于访问比较慢暂时没试过；gitee目前已经关闭了Page服务，所以此路也不通。

所以我找了一些其他的办法

将静态推送到Coding上进行托管，有6个月的免费试用期。具体步骤这里就不做详细介绍了
购买阿里云、华为云等服务器，将站点发布到服务器上，具体步骤这里就不做详细介绍

gitbook安装使用看完这一篇就够了相关推荐

分享一波关于做Kaggle比赛，Jdata，天池的经验，看完我这篇就够了。
@Author : Jasperyang @School : BUPT 这篇文章同时在知乎里放着- 写在前面 Kaggle的数据挖掘比赛近年来很火,以至于中国兴起了很多很多类似的比赛,做了两个这种类型 ...
网络安全工程师入门教程（非常详细）从零基础入门到精通，看完这一篇就够了
前言想要成为网络安全工程师,却苦于没有方向,不知道从何学起的话,下面这篇网络安全入门教程可以帮你实现自己的网络安全工程师梦想,如果想学,可以继续看下去,文章有点长,希望你可以耐心看到最后! 1. ...
网络安全入门教程（非常详细）从零基础入门到精通，看完这一篇就够了！
想要成为黑客/红客,却苦于没有方向,不知道从何学起,下面这篇网络安全入门教程可以帮你实现自己的黑客梦想,如果想学,可以继续看下去,文章有点长,希望你可以耐心看到最后网络安全入门路线 Web安全相关概 ...
Ubuntu18.04系统配置全记录——看完这一篇就够了
本博客用来记录自己安装完Ubuntu18.04系统之后所做的各种配置工作,基本上覆盖了很多大家熟悉的操作,走完整个流程之后,基本上就能得心应手使用Ubuntu18.04系统了. 介绍 Ubuntu18 ...
程序员入门教程【非常详细】从零基础入门到精通，看完这一篇就够了 !
零基础编程入门先学什么?编程语言有几百种,我们应该怎么选择.想学习编程,加入互联网行业,哪一个更有前途?在小白学习编程会有各种各样的问题,今天小编我就来为你解答. 一.怎么选择编程语言编程语言有很多 ...
网络安全工程师需要学哪些内容？零基础如何从入门到精通，看完这一篇就够了
网络安全工程师需要学习哪些内容? 作为一名网络安全工程师,需要学习以下内容: 计算机网络和操作系统:网络安全工程师需要了解计算机网络和操作系统的基础知识,以便理解网络安全的基础原理. 网络协议和技术: ...
【2023版】超详细XShell免费版的安装配置教程以及使用教程，看完这一篇就够了
目录一. XShell的作用二. 下载免费版XShell 三. 安装XShell 四.使用XShell连接Linux服务器一. XShell的作用 XShell 是一种流行且简单的网络程序,旨在 ...
【2023版】超详细Python+Pycharm安装保姆级教程，Python环境配置和使用指南，看完这一篇就够了
这两年被Python初学小白问到最多的问题就是,该用什么代码编辑工具? 说实话,我个人是用Jupyter Notebook最多,主要是经常做数据可视化,方便些. 但对于初学者来说,PyCharm仍是不 ...
VMware虚拟机安装（非常详细）从零基础入门到精通，看完这一篇就够了
目录一.下载VMware Wworkstation Pro 渠道: 安装: 二.安装虚拟机安装映像: 一.下载VMware Wworkstation Pro 渠道: 1.搜索引擎搜索 2.去vmw ...

gitbook安装使用看完这一篇就够了