gitbook使用指南-優(yōu)雅的markdown

Gitbook的安裝

node.js的安裝

gitbook是一個基于Node.js的命令行工具嵌言,所以要先安裝Node.js(下載地址:https://nodejs.org/en/,找到對應平臺的版本安裝即可)。

Node.js都會默認安裝npm(node包管理工具)抖剿,所以不需要單獨安裝npm池户,打開命令行片吊,執(zhí)行以下命令安裝GitBook:

npm install -g gitbook-cli

如果提示npm不是內部會外部命令,可以cd到node.js的安裝目錄在執(zhí)行或將npm的目錄添加到系統(tǒng)變量path中把还。

編輯工具的安裝

這里給大家介紹兩個編輯工具:gitbook editer和typora

gitbook editor

這個編輯工具對新手來說是個不錯的選擇实蓬,它集成了gitbook茸俭,git,Markdown等功能安皱,可以將書籍同步到gitbook.com網站和github调鬓。但是gitbook editor的注冊和登錄需要翻墻,而且這東西的官網進不去酌伊,所以還下不到腾窝。

這里給大家分享一下這個工具,會翻墻的可以嘗試一下這個工具

https://pan.baidu.com/s/1LEf2b9QwIRNgsoXJVBV90g

提取碼:vtpv

typora

這個工具是我目前在使用的居砖,推薦這個也沒有啥特別的原因虹脯,就是我自己感覺挺好用的

下載地址:https://www.typora.io/

直接進官網下載對應平臺的版本就可以了

Gitbook的使用

創(chuàng)建筆記文件夾

在你想要的位置新建一個文件夾,然后打開命令行奏候,cd到這個文件夾下循集。

接著執(zhí)行以下命令

gitbook init

執(zhí)行完后,文件夾里會多兩個文件

image

README.md(書籍的介紹在這個文件里)

SUMMARY.md(書籍的目錄結構在這里配置)

寫目錄

后面我介紹了一個生成目錄的插件蔗草,所以不一定要自己弄目錄暇榴,但這里還是說下怎么寫

上面說到SUMMRAY.md文件就是整個文件夾的目錄,寫目錄其實就是編輯這個文件蕉世,剛打開時這個文件里什么都沒有蔼紧,我先在給他編寫一下:

image

在給大家看看源代碼

# Summary

* [Introduction](README.md)
* [前言](readme.md)
* [第一章](part1/README.md)
    * [第一節(jié)](part1/1.md)
    * [第二節(jié)](part1/2.md)
    * [第三節(jié)](part1/3.md)
    * [第四節(jié)](part1/4.md)
* [第二章](part2/README.md)
* [第三章](part3/README.md)
* [第四章](part4/README.md)

大家可以復制源代碼過去試一下

簡單給大家說一下語法:中括號里是這個目錄的名字,小括號里是路徑狠轻。

寫完目錄后再次執(zhí)行gitbook init Gitbook會查找SUMMARY.md中描述的目錄和文件奸例,如果沒有則會創(chuàng)建。上面的目錄運行后是這樣的

image

寫筆記

在這里給大家介紹一些typora比較常用的功能

各級標題

在typora中使用crtl + 1~6可以創(chuàng)建1-6級標題向楼,1級最大飘言,6級最小二拐。同時typora的大綱會顯示所有標題竟宋,如圖:

image

表格

可以在段落--->表格中插入表格叨吮,或者按快捷鍵crtl+T

代碼塊

這個功能用的很頻繁,可以在段落--->代碼塊中插入昭抒,也可以使用快捷鍵(```+空格)

專注模式和打字機模式

打字機模式就是讓當前輸入行保持在屏幕中間评也,專注模式就是輸入行正常顏色,其他行變灰灭返,可以在視圖中打開

源代碼模式

源代碼模式就是展示Markdown的文件本來的樣子盗迟,如圖

這個模式會展示出Markdown文件的標識符

插入圖片

這個不多說,在格式--->圖像里熙含,快捷鍵crtl+shift+i

插入鏈接

用兩個尖括號括起來就行罚缕,如下:

<www.baidu.com>

更換主題

直接點主題就好,typora內置了6個主題怎静,值得一提的是typora的主題是css格式邮弹,所以會css的小伙伴可以自己寫主題黔衡,或者調整已有的主題

內容目錄

就是你們在本文上面看到的那個目錄,簡單點說就是把大綱放到了文章里腌乡,在段落--->內容目錄里可以找到(有標題時才能用)

常見的格式

就比如加粗盟劫,斜體,下劃線什么的导饲。在格式里有捞高,快捷鍵如下:

我的使用方法

其實單個md文件可以存儲很多筆記氯材,我現(xiàn)在是把一塊筆記存在一個md文件里渣锦,有一定規(guī)模后再裝文件夾,然后放在gitbook中氢哮,再使用我介紹的插件生成目錄袋毙。

插件的使用方法

在gitbook中有很多有用的插件,但是使用起來會有一點麻煩冗尤,這里給大家講解一下怎么用听盖。

gitbook的插件大部分都在npm上,可以訪問npm官網查看搜索插件https://www.npmjs.com/

這里用一個自動生成目錄的插件給大家介紹使用方法

名字叫:gitbook-plugin-summary

  1. 首先打開你筆記文件夾下的book.json文件裂七,沒有就自己創(chuàng)建一個

  2. 將以下代碼復制進去

    {
      "plugins": ["summary"]
    }
    
    
  3. 打開命令行皆看,在這個文件夾中執(zhí)行命令gitbook install安裝插件

  4. 執(zhí)行命令gitbook serve然后在查看的時候就會發(fā)現(xiàn),之前明明沒有寫目錄背零,現(xiàn)在卻有了目錄

大家想要用別的插件可以直接去npm上找腰吟,都有使用方法的

生成電子書

寫完后我們可以執(zhí)行gitbook serve來預覽這本書,執(zhí)行后會把Markdown格式的文檔轉換為html格式徙瓶,最后提示"Serving book on http://localhost:4000"此時用瀏覽器打開" http://localhost:4000"即可預覽書本

如圖:

image

執(zhí)行完后你的筆記文件夾里會多一個_book文件夾毛雇,里面是轉化后的html文件

筆記的同步

同步單個的md文件

對于單個的md文件,我建議同步到石墨文檔侦镇,可以在網頁版灵疮,桌面版,移動版三個版本上查看和編輯壳繁。操作方法就是打開然后帶入就行了震捣。當然,在博客上發(fā)布也不失為一種好的同步方法闹炉。

同步整個筆記文件

可以使用git同步到github伍派,由于我對git不太熟悉,就不誤導大家了剩胁,大家可以去網上找找

最后诉植,這是我第一次寫博客,而且我從接觸gitbook到寫完這篇博客只有短短三天昵观,如果有哪里不對晾腔,請各位指正

作者:Broken故城
鏈接:http://www.reibang.com/p/0388d8bb49a7
來源:簡書
著作權歸作者所有舌稀。商業(yè)轉載請聯(lián)系作者獲得授權,非商業(yè)轉載請注明出處灼擂。

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末壁查,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子剔应,更是在濱河造成了極大的恐慌睡腿,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件峻贮,死亡現(xiàn)場離奇詭異席怪,居然都是意外死亡,警方通過查閱死者的電腦和手機纤控,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進店門挂捻,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人船万,你說我怎么就攤上這事刻撒。” “怎么了耿导?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵声怔,是天一觀的道長。 經常有香客問我舱呻,道長醋火,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任狮荔,我火速辦了婚禮胎撇,結果婚禮上,老公的妹妹穿的比我還像新娘殖氏。我一直安慰自己晚树,他們只是感情好,可當我...
    茶點故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布雅采。 她就那樣靜靜地躺著爵憎,像睡著了一般。 火紅的嫁衣襯著肌膚如雪婚瓜。 梳的紋絲不亂的頭發(fā)上宝鼓,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天,我揣著相機與錄音巴刻,去河邊找鬼愚铡。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的沥寥。 我是一名探鬼主播碍舍,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼邑雅!你這毒婦竟也來了片橡?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤淮野,失蹤者是張志新(化名)和其女友劉穎捧书,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體骤星,經...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡经瓷,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了妈踊。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片了嚎。...
    茶點故事閱讀 37,997評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡泪漂,死狀恐怖廊营,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情萝勤,我是刑警寧澤露筒,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布,位于F島的核電站敌卓,受9級特大地震影響慎式,放射性物質發(fā)生泄漏。R本人自食惡果不足惜趟径,卻給世界環(huán)境...
    茶點故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一瘪吏、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蜗巧,春花似錦掌眠、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至望拖,卻和暖如春渺尘,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背说敏。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工鸥跟, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人盔沫。 一個月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓医咨,卻偏偏與公主長得像蚂夕,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子腋逆,可洞房花燭夜當晚...
    茶點故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內容