用gitbook做笔记如何部署到github(二)

首先我们先创建一个笔记的目录

可以在 SUMMARY.md 来添加本书目录

# Summary

* [Introduction](README.md)

* [vue](./vue/index.md)

    * [什么是vue](./vue/1-vue.md)

    * [vue指令](./vue/2-vue.md)

然后添加一些内容进来

添加一章,其中包括两个小节,方括号中是标题,小括号中是指向的文件,这里写 .md 后缀即可,不写 html 后缀。

浏览器中,看到目录出来了。


把笔记保存到github中

我们在自己的github新建一个仓库,然后把笔记上传到github上,添加.gitignore文件添加github忽略文件,忽略_book文件夹,执行以下命令上传到github。

cd gitbook-note

git init

git add -A

git commit -m"msg"

git remote add origin https://github.com/sunshineyanghui/gitbook-note.git

git push -u origin master

现在浏览器中访问https://github.com/sunshineyanghui/gitbook-note既可以看到笔记了。

编译成html

为了部署方便,现在我们修改一下文件的结构

cd gitbook-note

mkdir content

mv *.md content

mv vue content

现在运行gitbookserve会报错,但是会自动创建 docs 文件夹,文件夹中的内容,就是编译后的输出。

正确运行执行下列命令

gitbook serve ./content ./docs

每次启动的时候,都要敲长长的命令,很不方便,所以,我们就需要把命名简短化,具体就是去写成 npm 脚本

把项目变成一个nodejs的项目

npm init -y

生成一个package.json文件,在package.json添加一下代码

"scripts": {

        "build": "gitbook build ./content ./docs"

},        

然后执行命令运行

npm run build

这样 html 内容被编译好之后就会被保存到 docs 文件夹中。

部署到github pages

咱们来把 html 内容部署到公网上,用到的是 github 的 pages 服务。

docs 文件夹 Push 到 github

运行 git add -A; git commit 操作,把 docs 文件夹保存到版本中,然后 git push 上传。

浏览器中,到 https://github.com/sunshineyanghui/gitbook-note.git ,可以看到 docs/ 文件夹上传完毕。

配置 pages 服务

到 仓库配置页面 到 Github Pages 一项下面。Source 一项设置为 master branch docs folder 意思就是 master 分支的 docs 文件夹。


等待几分钟,到 https://sunshineyanghui.github.io/gitbook-note/,可以看到本笔记上线了。

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

推荐阅读更多精彩内容