如何用Github构建知识体系

前言:

书到用时方恨少,技能要用时也恨少啊!前几天从老大那里认领了个任务,整理文章形成gitbook在线阅读版本,哇高级了!简直懵逼啊!

从完全没听说过github和gitbook到现在整理出一份在线文档,内心还是有点小骄傲呢,所以我来把流程炫耀一下哈~

同时,此文还适用于很想构建自己的知识体系,但是不知道怎么做;想要积累自己的知识,并且实现变现,但是不知道怎么做;听说或没听说过github、gitbook但不知道怎么玩想尝试的童鞋们哒

目的:

  1. 梳理自己整理文章的流程,方便自己复习与巩固。
  2. 帮助有缘人学习使用github、gitbook、markdown等工具
  3. 从工具层切入,帮助更多人开始构建自己的知识专题。

准备:

新建Repo

一、Github远程端新建仓库

Repo的全称是Repository,你可以理解为仓库。里面装满了各种代码、文件、知识等……

1、打开Github(www.github.com),并选择New Repository,建立一个新的仓库。

Paste_Image.png

2、一共要填写四个部分,第一个是名称,请使用英文简写,第二个是描述,第三个是新建初始化说明文件(打勾),第四个是选择说明文件类型,下拉菜单中输入:gitbook,选择gitbook即可。

Paste_Image.png

3、点击下面的绿色按钮:“create repository”,一个Repo就会构建完成。

二、建立本地的Repo

1、请下载Github Desktop,并安装登录。

2、安装完成后,请点击Github Desktop左上角的加号,并选择第三个选项:Clone

Paste_Image.png

3、找到你刚才在第一步里面新建的那个Repo,选中后点击:clone Repository。
(这一步的目的就是将Github远程端的Repo同步到本地,类似于同步盘的概念)

4、点击clone之后,会弹出具体的文件夹地址,请大家自行找到保存的目录。

三、配置编辑器

1、下载安装编辑器,推荐两款:markeditor & ulysses

2、文件-打开文档-打开刚才保存的Repo目录

3、新建标配文件 :因为我们的知识要通过Gitbook进行解析,这里需要2个必备的文件。

  • README.md文件。这个文件用来说明这本书是干啥用的。在第一步建立Repo的时候,我们在第三小步的时候已经生成了README.md。这里就不用考虑了。

  • SUMMARY.md文件。这个文件是Gitbook用来生成目录的文件。这里只需要在ME中选择“+”文件命名为summary就好啦,内容即根据目录需要所填写。

Paste_Image.png

四、生成知识专题

1.首先你需要打开Gitbook,地址:www.gitbook.com

2.选择Sign in,并且使用Github来sign in。这样可以保证Gitbook可以读取你的每个Repo

3.在Gitbook中选择 +New Book

4.选择Github同步的方式,点击,并在右侧输入相应的名称

Paste_Image.png
Paste_Image.png

5.完成后点击:Greate Book,等待20秒钟,你的书籍就构建完成了

协作写作

一、Fork仓库

当你需要同别人协作共同完成一本gitbook或者你想修改别人的gitbook时,找到相应的github地址,点击右上角的fork按钮。

Paste_Image.png

此时你的账号下已经“复制了”一份gitbook,然后你就可以做修改了。

二、修改文件

修改有两种方法:可以直接在线修改,也可以先克隆到本机再修改,对于比较复杂的项目一般采取后者。

  • 在线修改

    • 直接在页面上点要修改的book的名字,进入详情页,再点击“Edit”。
    • 在编辑页面编辑完后,滚动到页面底部,点击绿色的“Commit Changes”按钮确认提交。
  • 本地修改

    • 打开Github Desktop,克隆到本地
    • 打开MarkEditor,找到保存的目录,打开
    • 编辑并保存
    • 此时在Github Desktop中,你会发现他在Changes出现了改变
    • 填写summary(可以理解为修改的摘要),点击Commit(这里是提交到本地的hub中)
    • 当出现以下页面时,点击右上角的Sync(将本地hub的修改同步到远程的hub中)
Paste_Image.png

三、申请合并

在确认已经对自己Fork了的仓库修改成功后,你可以将提交合并申请,申请将你的版本合并入最初的项目中。

这一步依然有两种方法:

  • 在线申请
    • 在网页上打开你Fork的gitbook的页面,点击这个醒目的绿色按钮
Paste_Image.png

+ 再点击“Create pull request”按钮,提交申请,完成后原文档创建者会收到通知

  • 本地申请
    • 修改完,在GithubDesktop点击Commit to master 和Sync同步后,点击“pull request”
Paste_Image.png
  • 当出现以下图标表示提交申请完成。
Paste_Image.png

三、合并申请

当共同编辑同一处文档时,会出现冲突,所以需要先处理完冲突后再合并分支。

  • 打开github.com,会收到提交申请
  • 点击resolve conflicts处理冲突
Paste_Image.png
  • 红色的标记表明出现冲突的地方,删除错误的不需要的文字和红色的标记即可。
Paste_Image.png
  • 点击Mark as resolve保存
Paste_Image.png
  • Commit changes提交修改
Paste_Image.png
  • 冲突解决了,点击Merge pull request合并请求就好啦
Paste_Image.png

感谢

  • 感谢永澄老师教授的这个技能包,还有永澄老师布置任务的契机,如果不是上手做任务,我可能不会研究github这么久,也不会发现这么个新天地~
  • 感谢光光在我卡壳的时候给我发资源,给我耐心指导,么么哒~
  • 感谢晶磊师父的远程、语音讲解与指导解决矛盾与合并分支等问题,哎~程序猿的世界好奇妙~

附:相关资源

这是一个神奇的资源库!

xiaolubobo的录屏~

最后

一个技术白痴写的东西,目前也就理解到这个程度,肯定有很多不对的地方,欢迎指正!大家一起交流学习~

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,391评论 25 707
  • Lesson 3: Using GitHub to Collaborate 3.1 Creating a GitH...
    赤乐君阅读 6,032评论 3 11
  • “小男孩的小名叫天天,自天天记事起,他的身边就没有爸爸。只有妈妈和外公。还有隔壁的许叔叔会经常给他买糖吃,教他玩游...
    宁我阅读 332评论 0 1
  • 在长泰广场,姐姐在逛服装店 站在门外 迎着冷风 啃着西红柿 口腔溃疡和温度让催熟的家伙尝起来惨极了 商场的灯光 现...
    门中人阅读 175评论 0 0