用Gitbook组织文档并展示到Github的Pages中

Gitbook 是一个基于 Node.js 的命令行工具,可使用 Github/GitMarkdown 来编写电子书。支持 Markdown,插件众多是其最大特点,用来组织产品文档,FAQ或WIKI都是不错的选择。

GithubPages 功能则允许将创建好的电子书文档发布到个人网页,以便于在线访问。

第一阶段:安装Gitbook实现本地预览

此阶段的目的为在本地安装 Gitbook ,并成功的预览文件

1) 为了可以在 Windows10 本地编译和预览 Gitbook 生成的文档,需要先下载 nodejs 并安装

下载地址:https://nodejs.org/en/,推荐下载稳定版

image

安装过程不表,默认安装即可

2) 安装完成后,需要将安装路径添加到「环境变量」中,以便于在命令行中使用node和npm相关命令,

注释:配置路径为:控制面板->系统和安全->系统->高级系统设置->环境变量(按钮)
image

3) 配置完成后,在命令行中键入node -vnpm -v,若如图显示出对应版本号,则说明安装和配置都已完成

image

4) 下一步,在命令行中键入npm install gitbook-cli -g,开始安装gitbook

image

5)Github 上新建一个仓库 Repository (当然你首先得有Github账号),命名为 Test 。选择项目类型为公开 Public,并且
勾选 Initialize this repository with a README 以便创建README文件(建议勾选,似乎是gitbook本地编译时必须的文件)

image

创建好以后把远程仓库克隆到本地,切换到 Test 目录下,可以看看初始目录有哪些文件

image

6) 命令行中键入gitbook init初始化项目,初次操作会显示 Installing GitBook 3.2.3 ,需要等待一些时间让他自动安装一些插件,完成后会提示 info: initialization is finished ,Gitbook 自动创建了 SUMMARY.md 文件,这是电子书的目录文件

image

7) 命令行中键入gitbook serve会启动一个本地的服务(同时会新增一个 _book 目录),在浏览器其中访问地址就可以实时预览电子书

image

_ 预览成功!!!

image

第二阶段:展示到Github的page中

这个阶段的最终目的是要将我们本地编辑的文档通过 GithubPages 功能实现在线访问

1)Test 的项目里点击 settings ,找到 GitHub Pages

image

Source 我选择用 docs 目录下的内容来呈现项目文档,但这时发现选项是「禁用」的!!!

image

2) 在本地环境中先将编译文档到 docs 目录(这里我新增了一个 Blog.md 文件) ,在 SUMMARY.md 中添加访问链接后可直接在左侧的目录树显示

命令行中键入gitbook build . docs,将文件都编译到 docs 目录下

image

3) 然后将编译好的文件 PUSH 到远端仓库

$ git add *
$ git commit -m"Inital commit"
$ git push orgin master

4) 此时,再去 Settings 里去设置 PagesSource ,发现 master branch/docs folder 已经是可选的,选择后页面会刷新生成访问地址

image

_ 恭喜,能走到这一步,证明我们已经成功的将文档发布到 GithubPages ,我们只需要访问地址即可:

image

终于写完了,好TM累,睡觉。。

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

推荐阅读更多精彩内容

  • 概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命...
    辉这样说阅读 3,018评论 0 4
  • 本文详细讲解了 Gitbook 生成电子书的完整过程,内容包括:安装、命令、配置、文档结构、生成电子书、部署。限于...
    静默虚空阅读 11,248评论 9 138
  • 最近遇到一些问题,就是团队中会有些伙伴踩得坑的收集问题或者有些较为复杂的业务需求文档共享上成本较高,所以考虑弄...
    tobAlier阅读 3,895评论 0 5
  • 1. GitHub 1.1. 创建账户 https://github.com/ 在上面注册账户: gitexam...
    蝴蝶泉nq阅读 4,639评论 1 3
  • 本篇主要来介绍一下Java中的集合框架; 简化图如下: 对于以上框架需要说明:所有集合类都位于java.util包...
    星星_点灯阅读 278评论 0 0