ios 程序猿Family知识管理体系iOS学习

如何用Github构建知识体系

2017-02-20  本文已影响389人  许小小丽

前言:

书到用时方恨少,技能要用时也恨少啊!前几天从老大那里认领了个任务,整理文章形成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个必备的文件。

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,然后你就可以做修改了。

二、修改文件

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

Paste_Image.png

三、申请合并

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

这一步依然有两种方法:

Paste_Image.png

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

Paste_Image.png Paste_Image.png

三、合并申请

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

Paste_Image.png Paste_Image.png Paste_Image.png Paste_Image.png Paste_Image.png

感谢

附:相关资源

这是一个神奇的资源库!

xiaolubobo的录屏~

最后

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

上一篇 下一篇

猜你喜欢

热点阅读