但行好事
莫论前程❤

Linux下gitbook的使用

gitbook常见命令

gitbook build --gitbook=2.0.1       # 生成时指定gitbook的版本, 本地没有会先下载
gitbook ls                         # 列出本地所有的gitbook版本
gitbook ls-remote                   # 列出远程可用的gitbook版本
gitbook fetch 标签/版本号            # 安装对应的gitbook版本
gitbook update                     # 更新到gitbook的最新版本
gitbook uninstall 2.0.1             # 卸载对应的gitbook版本
gitbook build --log=debug           # 指定log的级别
gitbook build --debug               # 输出错误信息

目录结构

GitBook 基本的目录结构如下所示

.
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md
  • book.json
    • 存放配置信息,在下一章中所讲的配置信息都是在这个文件里定义的,关于该文件的配置可以看 配置 这个章节。
  • Summary
    • 概要文件主要存放 GitBook 的文件目录信息,左侧的目录就是根据这个文件来生成的,默认对应的文件是 SUMMARY.md,可以在 book.json 重新定义该文件的对应值。它通过 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)

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

Summary

我们通过使用 标题 或者 水平分割线 标志将 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)

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

Summary

Part I

Part II


  • Glossary
    • 词汇表文件,默认对应的文件是 GLOSSARY.md。该文件主要存储词汇信息,如果在其他页面中出现了该文件中的词汇,鼠标放到词汇上会给出词汇示意,可以将鼠标移到下面两个词汇上看下效果。

Glossary 文件的格式如下所示:

## Git
分散式版本控制软件

## Markdown
Aaron Swartz 跟John Gruber共同设计的排版语言

记录Gitbook的一些配置信息

title — 设置书本的标题

"title" : "Gitbook Use"

author — 作者的相关信息

"author" : "zhangjikai"

description — 本书的简单描述

"description" : "记录Gitbook的配置和一些插件的使用"

language — Gitbook使用的语言, 版本2.6.4中可选的语言如下:

指定使用的gitbook版本

"gitbook" : "3.2.2",
"gitbook" : ">=3.0.0"

root — 指定存放 GitBook 文件(除了 book.json)的根目录

"root": "."

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

"links" : {
    "sidebar" : {
        "Home" : "http://zhangjikai.com"
    }
}

styles — 自定义页面样式, 默认情况下各generator对应的css文件

"styles": {
    "website": "styles/website.css",
    "ebook": "styles/ebook.css",
    "pdf": "styles/pdf.css",
    "mobi": "styles/mobi.css",
    "epub": "styles/epub.css"
}

例如使<h1> <h2>标签有下边框, 可以在website.css中设置

h1 , h2{
    border-bottom: 1px solid #EFEAEA;
}

plugins — 配置使用的插件

"plugins": [
    "disqus"
]

添加新插件之后需要运行gitbook install来安装新的插件

Gitbook默认带有5个插件:

  • highlight
  • search
  • sharing
  • font-settings
  • livereload

如果要去除自带的插件, 可以在插件名称前面加-

"plugins": [
    "-search"
]

pluginsConfig — 配置插件的属性

"pluginsConfig": {
    "fontsettings": {
        "theme": "sepia",
        "family": "serif",
        "size":  1
    }
}

structure

指定 Readme、Summary、Glossary 和 Languages 对应的文件名,下面是这几个文件对应变量以及默认值:

变量含义和默认值
structure.readmeReadme file name (defaults to README.md)
structure.summarySummary file name (defaults to SUMMARY.md)
structure.glossaryGlossary file name (defaults to GLOSSARY.md)
structure.languagesLanguages file name (defaults to LANGS.md)

编写步骤

  1. 编写图书简介 README.md 文件输入如下内容:
#Introduction
这是一本使用 gitbook 制作电子书籍的快速上手指南。
分为两个章节:
第一章介绍 gitbook.com 在线平台
第二章介绍 gitbook 基础知识
  1. 创建章节目录:
$mkdir part1
$mkdir part2
  1. 编写实际内容

    进入第一章目录,编写第一章内容:

#README.md
GitBook除了是一个命令行工具,它同时也是间书籍发布平台和电子书店。桌面版本同时支持Mac、Windows、Linux三种平台。

#register.md
访问gitbook.com,如有GitHub帐号,直接使用GitHub帐号进行授权注册,这里使用GitHub帐号,是因为与GitHub进行关联时无需再次做GitHub授权操作。当然,你也可以注册一个GitBook帐号。

​ 进入第二章目录,并编写其内容:

#README.md
使用 `gitbook` 命令的前提,必须已经安装好`Node`、`Npm`,在准备工作中,我们已经将它们安装并配置好了,现在来查看下版本。  

#markdown.md
本节仅简要介绍 Markdown 的基本语法与展现......

以上都只是截取了章节目录的部分文件和内容.

  1. 配置SUMMARY.md文件

每完成一个章节内容,即可在图书目录内进行连接,当然也可全部完成后在进行连接。

#SUMMARY.md
* [Introduction](README.md)
* [前言](qian_yan.md)
* [准备工作和所具备知识](zhun_bei_gong_zuo.md)
* [1.gitbook](part1/README.md)
   * [1.1.gitbook.com账户注册](part1/register.md)
* [2.GitBook 基础](part2/README.md)
   * [2.1.Markdown 语法](part2/markdown.md)
  1. SUMMARY.md 结构说明
* 无序列表
[]章节名称
()章节对应的实际文件,包含相对路径

注: 另一种创建图书的方式是:先定义好 SUMMARY.md 内的图书结构,然后使用 gitbook init 命令生成图书目录和文件。这样的好处是有助于一本书的整体构思,坏处就是写作过程中很难变更图书结构(除非你不会有思维定式)。

赞(0) 打赏
未经允许不得转载:刘鹏博客 » Linux下gitbook的使用
分享到: 更多 (0)

评论 抢沙发

评论前必须登录!

 

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏