Loaing......

Gitbook|安装 - 廉一鸣的博客

Gitbook|安装

Posted by 廉一鸣 on December 6, 2020

Gitbook|安装

Gitbook

#

Windows安装

安装 Node.js

GitBook 是一个基于 Node.js 的命令行工具

首先去node的官网https://nodejs.org/en

下下来msi文件,点击运行,一路next就可以了

win7需要用老版本

https://nodejs.org/dist/latest-v10.x/

32位的就找到

node-v10.23.0-x64.msi   

64位的就找到

node-v10.23.0-x86.msi   

使用Gitbook

首先cd进去想要搞gitbook的目录

gitbook install
gitbook init

如果不install就会导致下边的book.json没办法用

接下来,我们输入 gitbook serve(跟jekyll一样jekyll serve

浏览器里访问

http://localhost:4000

也是http://127.0.0.1:400

效果

imgimg

运行命令后会在书籍的文件夹中生成一个 _book 文件夹 里面的内容是Gitbook生成的html网页

可以使用下面命令来生成网页而不开启服务(也就是访问不了)

gitbook build

目录结构

/
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md

book.json

不会自动生成,自己创建

该文件主要用来存放配置信息

具体类似这样

{ “title”: “高仿ios”, “author”: “廉一鸣”, “description”: “主题美化进阶路”,”language”: “zh-hans”, “gitbook”: “3.2.3”, “styles”: { “website”: “./styles/website.css” }, “structure”: { “readme”: “README.md” },”links”: {

},
"plugins": [
  "-sharing",
  "splitter",
  "-expandable-chapters-small",
  "anchors",
  "-github",
  "-github-buttons",
  "-donate",
  "sharing-plus",
  "-anchor-navigation-ex",
  "favicon",
  "lunr",
  "-search"

], “pluginsConfig”: { “sharing”: { “douban”: false, “facebook”: false,”google”: false, “hatenaBookmark”: false, “instapaper”: false, “line”: false,”linkedin”: false, “messenger”: false, “pocket”: false, “qq”: false, “qzone”: false, “stumbleupon”: false, “twitter”: false, “viber”: false, “vk”: false,”weibo”: false, “whatsapp”: false, “all”: [ “google”, “facebook”, “weibo”, “twitter”, “qq”, “qzone”, “linkedin”, “pocket” ] }, “anchor-navigation-ex”: { “showLevel”: false }, “favicon”:{ “shortcut”: “./source/images/favicon.jpg”, “bookmark”: “./source/images/favicon.jpg”, “appleTouch”: “./source/images/apple-touch-icon.jpg”, “appleTouchMore”: { “120x120”: “./source/images/apple-touch-icon.jpg”, “180x180”: “./source/images/apple-touch-icon.jpg” } } } }

title

本书标题

author

本书作者

description

本书描述

language

本书语言,中文设置 “zh-hans” 即可

gitbook

指定使用的 GitBook 版本

styles

自定义页面样式

structure

指定 Readme、Summary、Glossary 和 Languages 对应的文件名

在左侧导航栏添加链接信息

plugins

配置使用的插件

pluginsConfig

配置插件的属性

SUMMARY.md

这个文件主要决定 GitBook 的章节目录(就是书的目录),它通过 Markdown 中的列表语法来表示文件的父子关系,下面是一个简单的示例:

# Summary

* [Introduction](README.md)
* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)

这个配置对应的目录结构如下所示:

imgimg

我们通过使用 标题 或者 水平分割线 将 GitBook 分为几个不同的部分,如下所示:

# 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)

这个配置对应的目录结构如下所示:

imgimg

插件

GitBook 有 插件官网,默认带有 5 个插件,highlight、search、sharing、font-settings、livereload,如果要去除自带的插件, 可以在插件名称前面加 -,比如:

"plugins": [
    "-search"
]

如果要配置使用的插件可以在 book.json 文件中加入即可,比如我们添加 plugin-github,我们在 book.json 中加入配置如下即可:

不使用的一定要注释掉。不然会报错

{
    "plugins": [ "github" ],
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/your/repo"
        }
    }
}

然后在终端输入 gitbook install ./ 即可。

如果要指定插件的版本可以使用 plugin@0.3.1,因为一些插件可能不会随着 GitBook 版本的升级而升级。