使用gitbook管理個人知識

每個程序員都會進行個人知識管理,我自己在個人wiki上經歷過幾個階段:

最開始使用在線筆記,后來不用.一是習慣了vim,可視化后按鍵別扭; 二是使用筆記容易copy/paste,自己整理的少,懶.

使用vim+vimwiki插件.后來不用,一是那時候vimwiki還不支持markdown,而是使用特定語法;二是vimwiki生成html頁面,效果看個人的css,而前端正式我的弱項,所以我的頁面很難看.

使用gitpage+jekyll+markdown.很多人用這個承載blog,開始的時候是把wiki直接放到這個上,但是很多雜亂的草稿直接公開不是太好。而且jekyll沒有toc,搜索上不是很好。最后只有自己的blog還用這個.就是現在這個網站。

現階段, gitbook來維護自己的wiki。實際上gitbook就是用git+markdown來編寫書籍的解決方案。效果是這個樣子:

為什么選擇gitbook做wiki管理

三個理由:

系統性。gitbook是適合寫書的,寫書需要系統性,所以gitbook有左側的目錄欄。wiki往往是片段的,所以系統性非常重要。TOC是個人選擇gitbook的最重要的因素。

書寫上,markdown+git天生適合程序員,高效便利。

gitbook展示非常好,html,pdf都可以,上面的圖就可以看出來,而且還提供搜索。

本地gitbook-server安裝

gitbook-server可以將文檔目錄轉換成html網站,或者pdf等.

軟件包方式安裝

On Ubuntu14.04

sudo apt-getinstallnodejssudo apt-getinstallnpmsudo npminstall-g gitbook-cliapt-getinstallnodejs-legacy

通過docker使用gitbook-server

docker pull billryan/gitbookdocker run-d-v"$PWD:/gitbook"-p4000:4000billryan/gitbook gitbook? serve --watch

gitbook-server使用

gitbookserve .# 更多信息查看幫助信息gitbook --help

gitbook使用舉例

準備文件和目錄

mkdir gitbook-democdgitbook-demomkdir chapter1touch? chapter1/{readme,1,2}.mdtouch README.mdechotest> README.md

編寫目錄

vim SUMMARY.md*[前言](README.md)*[第一章](chapter1/readme.md)? * [第一節](chapter/1.md)? * [第二節](chapter/2.md)

SUMMARY.md是目錄文件,gitbook生成網頁左側的目錄就是SUMMARY.md文件中記錄的.

運行gitbook server

gitbookserve . --port8888

非常簡單吧,這樣我們就可以專注于內容了。

幾點說明

上面介紹的是本地使用gitbook-server。還可以使用gitbook.com的服務,支持一本私有圖書,無限公開圖書,可以和github聯動,只要將代碼提交到github,gitbook網站會自動的生成,可是國內的訪問速度基本無法使用。

還有個工具是gitbook-editor,可視化的markdown編輯工具,gitbook.com提供,做了深度集成。不怎么推薦使用,目前不太好用,而且markdown就是為了編寫時不考慮展示,用了可視化工具,感覺效率不怎么高了。

使用docker運行gitbook-server非常方便。gitlab+jenkins+docker(gitbook-server)可以非常便捷地提供研發文檔解決方案。只要開發人員想代碼一樣提交變更,文檔就自動生成了,目前我們組就是采用了這套方案,效果很好。形成了文檔的CICD,質量很好。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,428評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,024評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,285評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,548評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,328評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,878評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,971評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,098評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,616評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,554評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,725評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,243評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,971評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,361評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,613評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,339評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,695評論 2 370

推薦閱讀更多精彩內容

  • Gitbook是一個命令行工具,可以把你的Markdown文件匯集成電子書,并提供PDF等多種格式輸出。你可以把G...
    陳云峰閱讀 6,404評論 1 7
  • 開發中我們正面臨的問題... API發展的當下與趨勢標準化API越來越多跨平臺調用需求越來越普及開放平臺普及化 A...
    特里斯譚閱讀 4,758評論 3 62
  • 本文詳細講解了 Gitbook 生成電子書的完整過程,內容包括:安裝、命令、配置、文檔結構、生成電子書、部署。限于...
    靜默虛空閱讀 11,275評論 9 138
  • 肩膀好痛好痛。 感覺很孤獨無助,傷心難過,就像被全世界拋棄了一樣。 哥哥突然叫住我,我心里在想,叫我肯定沒好事。 ...
    周海雙閱讀 232評論 0 1
  • 我以前在老家時在一家國有煤礦工作,單位有位工會主席姓張。老頭子脾氣不小,跟多大的官說話頭都昂的高高的。和我們這...
    I貔貅閱讀 852評論 12 13