如何写一本静态网站的书籍-GitBook(Mac)

序言

首先看下我们要实现的效果是怎么样的。通过下面的图片,可以看到,左边就是书籍目录的导航栏,导航栏的上面还有全局搜索功能(每一个子目录的内容都可以搜到),内容的显示界面还可以选择几个阅读风格(A)。个人觉得比电子书还方便,有兴趣的可以玩一下。资料整理归类的超方便。
接下来要讲的就是如何实现了,我这里用的gitbook。也可以说是gitbook的教程吧。


gitbook基本界面.png

GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git的教程。

1.安装

1.1安装npm

从网站 https://nodejs.org/#download 下载node.apk 安装即可

// 检查npm是否安装成功 
npm -v 
// 检查node是否存在 
node -v

1.2安装gitbook


// 安装Gitbook命令(mac要用这个才能成功安装)
sudo npm install -g gitbook-cli
// 检查是否安装成功
gitbook -v
  • 注意事项

  • 不能使用 npm install gitbook -g 命令安装,因为使用命令gitbook的时候会出现问题。
  • 安装的命令前需要加入sudo,因为可能会找不到npm的 /usr/local/bin/路径。
  • 使用gitbook -v命令检查时可能会不出现版本号,但其实是安装好了。

2.使用

Gitbook的基本规则
Gitbook需要2个基本文件:

  • README.md
  • SUMMARY.md

README.md是关于你的书的介绍,而SUMMARY.md中则包含了书目,即章节结构,它的格式如下:

* [第1章](c1.md) 
  * [第1节](c1s1.md) 
  * [第2节](c1s2.md)
* [第2章](c2.md)
  * [第1节](c2s1.md) 
  * [第2节](c2s2.md)

2.1根据目录生成图书结构

2.1.1 README.md 与 SUMMARY编写

  • README.md

这个文件相当于一本Gitbook的简介。

//创建目录/test_gitbook
mkdir test_gitbook
//新建文件README.md
touch README.md
  • SUMMARY.md

这个文件是一本书的目录结构,使用Markdown语法,如我们这本书的SUMMARY.md:

// 创建文件
touch SUMMARY.md
// 此命令为终端改写文件(不方便),建议直接用Markdown软件直接编写
vim SUMMARY.md

SUMMARY.md文件的编写
输入

* [简介](README.md)
  * [第一章](chapter1/chapter1.md) 
    * [第一节](chapter1/section1.md)  
    * [第二节](chapter1/section2.md)
  * [第二章](chapter2/chapter2.md) 
    * [第一节](chapter2/section1.md) 
    * [第二节](chapter2/section2.md)
* [结束](end/README.md)

2.2 生成图书结构

当这个目录文件创建好之后,我们可以使用Gitbook的命令行工具将这个目录结构生成相应的目录及文件:

gitbook init
// 查看建立的目录和文件,此命令需要安装 tree、 安装tree的终端命令:brew install tree
tree 

目录如下:

.
├── chapter1
│    ├── chapter1.md
│    ├── section1.md
│    └── section2.md
├── chapter2
│     ├── chapter2.md
│     ├── section1.md
│     └── section2.md
├── end
│     └── README.md
├── README.md
└── SUMMARY.md

可以看到,gitbook生成了与SUMMARY.md所对应的目录及文件。
每个目录中,都有一个README.md文件,相当于一章的说明。
生成图书

2.2 输出为静态网站

2.2.1 本地预览时自动生成

编辑好图书之后,使用Gitbook的命令行进行本地预览:

//该操作需在文件路径下
gitbook serve

然后浏览器中输入 http://localhost:4000 就可以预览生成的以网页形式组织的书籍。

同时图书项目的目录中多了_book的文件目录,而这个目录中的文件,即是生成的静态网站内容。(用这个命令生成的静态网站,在没有服务器的情况下,不能返回首页,
如果想要_book的内容在本地被访问,可以使用以前的gitbook版本生成,我这里用的是2.6.7)

//用指定版本的gitbook生成
gitbook build --gitbook=2.6.7

使用build参数将文件生成到指定目录:

//新建目录
mkdir /tmp/gitbook
//输出到制定目录
gitbook build --output=/tmp/gitbook

2.2.2 输出PDF

使用Gitbook写开源书籍,过一把作家瘾

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

推荐阅读更多精彩内容