前言:
書到用時(shí)方恨少,技能要用時(shí)也恨少?。∏皫滋鞆睦洗竽抢镎J(rèn)領(lǐng)了個(gè)任務(wù),整理文章形成gitbook在線閱讀版本,哇高級(jí)了!簡(jiǎn)直懵逼??!
從完全沒聽說過github和gitbook到現(xiàn)在整理出一份在線文檔,內(nèi)心還是有點(diǎn)小驕傲呢,所以我來把流程炫耀一下哈~
同時(shí),此文還適用于很想構(gòu)建自己的知識(shí)體系,但是不知道怎么做;想要積累自己的知識(shí),并且實(shí)現(xiàn)變現(xiàn),但是不知道怎么做;聽說或沒聽說過github、gitbook但不知道怎么玩想嘗試的童鞋們噠
目的:
- 梳理自己整理文章的流程,方便自己復(fù)習(xí)與鞏固。
- 幫助有緣人學(xué)習(xí)使用github、gitbook、markdown等工具
- 從工具層切入,幫助更多人開始構(gòu)建自己的知識(shí)專題。
準(zhǔn)備:
注冊(cè)Github賬戶,地址:www.github.com
下載Github Desktop客戶端,地址:desktop.github.com (如果無法下載的話,請(qǐng)使用離線下載地址: github離線安裝包(windows)的下載地址: https://github-windows.s3.amazonaws.com/standalone/GitHubDesktop.exe)
準(zhǔn)備一個(gè)Markdown編輯器,推薦:MarkdownPad(windows)、Ulysses(OS)、MarkEditor(通用)。(Markeditor的訪問地址:http://zrey.com/app/markeditor?from=farbox)
準(zhǔn)備一個(gè)知識(shí)主題,這個(gè)主題可以很小,可以是你的某個(gè)工作、一篇讀書筆記都可以(用來跟著練手)
新建Repo
一、Github遠(yuǎn)程端新建倉庫
Repo的全稱是Repository,你可以理解為倉庫。里面裝滿了各種代碼、文件、知識(shí)等……
1、打開Github(www.github.com),并選擇New Repository,建立一個(gè)新的倉庫。

2、一共要填寫四個(gè)部分,第一個(gè)是名稱,請(qǐng)使用英文簡(jiǎn)寫,第二個(gè)是描述,第三個(gè)是新建初始化說明文件(打勾),第四個(gè)是選擇說明文件類型,下拉菜單中輸入:gitbook,選擇gitbook即可。

3、點(diǎn)擊下面的綠色按鈕:“create repository”,一個(gè)Repo就會(huì)構(gòu)建完成。
二、建立本地的Repo
1、請(qǐng)下載Github Desktop,并安裝登錄。
2、安裝完成后,請(qǐng)點(diǎn)擊Github Desktop左上角的加號(hào),并選擇第三個(gè)選項(xiàng):Clone

3、找到你剛才在第一步里面新建的那個(gè)Repo,選中后點(diǎn)擊:clone Repository。
(這一步的目的就是將Github遠(yuǎn)程端的Repo同步到本地,類似于同步盤的概念)
4、點(diǎn)擊clone之后,會(huì)彈出具體的文件夾地址,請(qǐng)大家自行找到保存的目錄。
三、配置編輯器
1、下載安裝編輯器,推薦兩款:markeditor & ulysses
2、文件-打開文檔-打開剛才保存的Repo目錄
3、新建標(biāo)配文件 :因?yàn)槲覀兊闹R(shí)要通過Gitbook進(jìn)行解析,這里需要2個(gè)必備的文件。
README.md文件。這個(gè)文件用來說明這本書是干啥用的。在第一步建立Repo的時(shí)候,我們?cè)诘谌〔降臅r(shí)候已經(jīng)生成了README.md。這里就不用考慮了。
SUMMARY.md文件。這個(gè)文件是Gitbook用來生成目錄的文件。這里只需要在ME中選擇“+”文件命名為summary就好啦,內(nèi)容即根據(jù)目錄需要所填寫。

四、生成知識(shí)專題
1.首先你需要打開Gitbook,地址:www.gitbook.com
2.選擇Sign in,并且使用Github來sign in。這樣可以保證Gitbook可以讀取你的每個(gè)Repo
3.在Gitbook中選擇 +New Book
4.選擇Github同步的方式,點(diǎn)擊,并在右側(cè)輸入相應(yīng)的名稱


5.完成后點(diǎn)擊:Greate Book,等待20秒鐘,你的書籍就構(gòu)建完成了
協(xié)作寫作
一、Fork倉庫
當(dāng)你需要同別人協(xié)作共同完成一本gitbook或者你想修改別人的gitbook時(shí),找到相應(yīng)的github地址,點(diǎn)擊右上角的fork按鈕。

此時(shí)你的賬號(hào)下已經(jīng)“復(fù)制了”一份gitbook,然后你就可以做修改了。
二、修改文件
修改有兩種方法:可以直接在線修改,也可以先克隆到本機(jī)再修改,對(duì)于比較復(fù)雜的項(xiàng)目一般采取后者。
-
在線修改
- 直接在頁面上點(diǎn)要修改的book的名字,進(jìn)入詳情頁,再點(diǎn)擊“Edit”。
- 在編輯頁面編輯完后,滾動(dòng)到頁面底部,點(diǎn)擊綠色的“Commit Changes”按鈕確認(rèn)提交。
-
本地修改
- 打開Github Desktop,克隆到本地
- 打開MarkEditor,找到保存的目錄,打開
- 編輯并保存
- 此時(shí)在Github Desktop中,你會(huì)發(fā)現(xiàn)他在Changes出現(xiàn)了改變
- 填寫summary(可以理解為修改的摘要),點(diǎn)擊Commit(這里是提交到本地的hub中)
- 當(dāng)出現(xiàn)以下頁面時(shí),點(diǎn)擊右上角的Sync(將本地hub的修改同步到遠(yuǎn)程的hub中)

三、申請(qǐng)合并
在確認(rèn)已經(jīng)對(duì)自己Fork了的倉庫修改成功后,你可以將提交合并申請(qǐng),申請(qǐng)將你的版本合并入最初的項(xiàng)目中。
這一步依然有兩種方法:
- 在線申請(qǐng)
- 在網(wǎng)頁上打開你Fork的gitbook的頁面,點(diǎn)擊這個(gè)醒目的綠色按鈕

+ 再點(diǎn)擊“Create pull request”按鈕,提交申請(qǐng),完成后原文檔創(chuàng)建者會(huì)收到通知
- 本地申請(qǐng)
- 修改完,在GithubDesktop點(diǎn)擊Commit to master 和Sync同步后,點(diǎn)擊“pull request”

- 當(dāng)出現(xiàn)以下圖標(biāo)表示提交申請(qǐng)完成。

三、合并申請(qǐng)
當(dāng)共同編輯同一處文檔時(shí),會(huì)出現(xiàn)沖突,所以需要先處理完沖突后再合并分支。
- 打開github.com,會(huì)收到提交申請(qǐng)
- 點(diǎn)擊resolve conflicts處理沖突

- 紅色的標(biāo)記表明出現(xiàn)沖突的地方,刪除錯(cuò)誤的不需要的文字和紅色的標(biāo)記即可。

- 點(diǎn)擊Mark as resolve保存

- Commit changes提交修改

- 沖突解決了,點(diǎn)擊Merge pull request合并請(qǐng)求就好啦

感謝
- 感謝永澄老師教授的這個(gè)技能包,還有永澄老師布置任務(wù)的契機(jī),如果不是上手做任務(wù),我可能不會(huì)研究github這么久,也不會(huì)發(fā)現(xiàn)這么個(gè)新天地~
- 感謝光光在我卡殼的時(shí)候給我發(fā)資源,給我耐心指導(dǎo),么么噠~
- 感謝晶磊師父的遠(yuǎn)程、語音講解與指導(dǎo)解決矛盾與合并分支等問題,哎~程序猿的世界好奇妙~
附:相關(guān)資源
最后
一個(gè)技術(shù)白癡寫的東西,目前也就理解到這個(gè)程度,肯定有很多不對(duì)的地方,歡迎指正!大家一起交流學(xué)習(xí)~