gitbook构建文档系统

简介

GitBook是一个基于node.js的命令行工具,可使用Github/Git和Markdown来制作精美的电子书

使用

假如您已经安装了node,您可以使用npm做以下的操作。

项目中安装gitbook-cli(非全局) 注意:下面使用的npx指令,会自动去./node_modules/.bin目录下面搜索执行指令。如果不使用npx指令,可以使用node_modules\.bin\gitbook build(window系统)这种方式执行gitbook指令

  1. 新建文件夹(初始化项目)
npm init
  1. 下载gitbook-cli(下面都是在本地安装演示)
npm install gitbook-cli --save--dev
// 或者您也可以全局下载npm install gitbook-cli -g
  1. 生成SUMMARY.md
npx gitbook init
  1. 可以打开连接直接使用
npx gitbook serve
  1. 或者简单的构建,可以放在站点使用
npx gitbook build

以上的步骤,可以搭建起一个最简单版本的系统。如果您需要搭建一个功能更加完善的系统,请跟着下面操作

输出格式

gitbook能将文档生成以下几个格式

  1. 静态页面
npx gitbook build
  1. eBook: 首先下载ebook-convert创建(有待测试)
    • 生成PDF:
    • 生成ePub:
    • 生成MOBI:
  2. JSON
npx gitbook build ./myrepo --format=json

文档格式

一个文档系统中至少包含2个文件:README.md 和 SUMMARY.md。

README.md

用来介绍您的文档的。在初始化的时候,会被自动加到摘要(SUMMARY.md)中

SUMMARY.md

SUMMARY.md是用来定义文档结构的,需要包含章的列表,并且链接到各自的页面。

Example:

# Summary
 
This is the summary of my book.
 
* [section 1](section1/README.md)
    * [example 1](section1/example1.md)
    * [example 2](section1/example2.md)
* [section 2](section2/README.md)
    * [example 1](section2/example1.md)

国际化

GitBook支持构建多语言文档。在项目的根目录中,创建一个LANGS.md文件。注意:每种语言有一个单独的子目录,并且这个目录包含至少README.mdSUMMARY.md这两个文件。
Example:

* [English](en/)
* [French](fr/)
* [Español](es/)

名词解释

可以在GLOSSARY.md这个文件中定义需要解释的名词,当鼠标移动到这个名词上面,会出现名词解释的信息。 ==非ascii码会被自动忽略,不会出现名词解释==

Example:

# term
Definition for this term
 
# Another term
With it's definition, this can contain bold text and all other kinds of inline markup ...

变量模版

可以把一系列变量定义到book.json中:

{
    "variables": {
        "host": "mybook.com"
    }
}

内容引用

在同一个项目中引用或者引用git仓库中的

{% include "./test.md" %}

{% include "git+https://github.com/GitbookIO/documentation.git/README.md#1.0.1" %}

忽略文件或文件夹

GitBook会读取.gitignore,.bookignore.ignore中的内容并且忽略他们。最好忽略node_modules和GitBook中构建的文件或者文件夹

node_modules
_book
*.epub
*.mobi
*.pdf
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容

  • 概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命...
    辉这样说阅读 3,017评论 0 4
  • 本文详细讲解了 Gitbook 生成电子书的完整过程,内容包括:安装、命令、配置、文档结构、生成电子书、部署。限于...
    静默虚空阅读 11,229评论 9 138
  • Gitbook是一个命令行工具,可以把你的Markdown文件汇集成电子书,并提供PDF等多种格式输出。你可以把G...
    陳云峰阅读 6,345评论 1 7
  • 楠木南 你们对朋友的定义是什么呢? 是和你一起风闹得朋友 还是无话不谈的朋友 还是在你需要帮助的时候帮助你的是朋友...
    谷无零阅读 148评论 0 0
  • 公元2249年 有一位有着王室血统的女孩 根据古老的故事所讲述的 她是最美的女孩 在被荆棘包裹的石制城堡里 她独自...
    须弥生阅读 195评论 0 0