麦田的博客

GitBook介绍安装和使用教程

2020-03-26


GitBook介绍

GitBook和hugo、hexo类似,但侧重于生成电子书,项目说明等内容!

1、安装 Node.js

GitBook 是一个基于 Node.js 的命令行工具,安装Node.js后,用以下命令检查是否安装成功!本人的Win10电脑之前安装hexo时已经安装过:Win10系统安装Hexo教程

右键点击开始菜单,再点击命令提示符(管理员),显示如下:

C:\WINDOWS\system32>
输入:node -v
显示:v10.16.3 # 这是版本号,表示已经安装成功

附注,如果点击命令提示符,会显示C:\Users\电脑用户名,比如zhang>

2、安装 GitBook

输入命令安装 GitBook:install gitbook-cli -g,检验是否安装成功:

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

3、GitBook常用命令

新建项目:在D盘新建文件夹,在文件夹内打开命令行:gitbook init

预览项目:gitbook serve

预览网址:http://localhost:4000/

生成静态网站:gitbook build

4、GitBook的文件介绍

新建项目后,在文件夹内会创建 README.md 和 SUMMARY.md,README.md 是说明文档,SUMMARY.md 是书的章节目录,示例如下:

# Summary

* [本书介绍/前言](README.md)

## 第一章

* [第一节](1001.md)
* [第二节](1002.md)

## 第二章/Part II

* [第一节](2001.md)
* [第二节](2002.md)

---

* [结语](title.md)

普通写法如下

# Summary

### Part I

* [Introduction](README.md)
* [Writing is nice](part1/writing.md)
* [GitBook is nice](part1/gitbook.md)

### Part II

* [We love feedback](part2/feedback_please.md)
* [Better tools for authors](part2/better_tools.md)

---

* [Last part without title](part3/title.md)

5、配置文件book.json

这个文件需要自己新建,并放在根目录下,示例如下

{
    "author": "作者名字",
    "description": "描述",
    "extension": null,
    "generator": "site",
    "isbn": null,
    "links": {
        "sharing": {
            "all": null,
            "facebook": null,
            "google": null,
            "twitter": null,
            "weibo": null
        },
        "sidebar": {
            "链接": "http://www..com"
        }
    },
    "output": null,
    "pdf": {
        "fontSize": 16,
        "footerTemplate": null,
        "headerTemplate": null,
        "margin": {
            "bottom": 36,
            "left": 62,
            "right": 62,
            "top": 36
        },
        "pageNumbers": false,
        "paperSize": "a4"
    },
    "plugins": [],
    "title": "书名",
    "variables": {}
}

6、GitBook主题和插件

GitBook的默认主题是黑白色,非常简洁,已经很完美,她还有彩色主题可以选择;

GitBook默认自带五个插件,可以禁用,也可以下载使用更多插件!


相关内容

  • Hugo升级方法和遇到的问题
  • Markdown软件推荐
  • 静态博客生成器大全和简评
  • Win10系统安装Jekyll详细教程
  • Hugo主题beautiful的优化
  • Hugo主题LeaveIt优化
  • Hugo主题hyde的配置
  • Markdown添加视频(hugo和hexo添加视频)
  • Markdown添加音频音乐歌曲-hexo添加音乐
  • VuePress静态博客生成器介绍
  • 标签

    GitBook静态网站生成器电子书