GitBook 使用筆記

1. 安裝

2. 使用

了解下面幾點(diǎn),基本就可以愉快的在本地寫書了

2.1 命令行基本命令使用

  • 新建書籍,在目錄中執(zhí)行:
    gitbook init
  • 構(gòu)建預(yù)覽html文件
    gitbook build
  • 開啟服務(wù)在瀏覽其中預(yù)覽
    gitbook serve

傳送門:
安裝使用:Setup and Installation of GitBook

  • 編輯后提交到Git庫:
git add .    
git commit -m "提交備注"

2.2 了解目錄結(jié)構(gòu)

不累述,直接傳送官方說明:

傳送門:
目錄結(jié)構(gòu)
頁面和內(nèi)容目錄

2.3 了解book.json 配置方法

傳送門:
book.json 配置

3. 插件安裝與配置

插件搜索瀏覽: GitBook Plugins

3.1 代碼高亮

1) prism插件

點(diǎn)擊上方鏈接查看如何配置(下同)

3.2 TOC(Table of Content)

1) 頁面內(nèi) - navigator

在標(biāo)題下方顯示目錄

2) 側(cè)邊 - simple-page-toc
  • 在右上方顯示一個(gè)TOC 按鈕,點(diǎn)擊后顯示目錄
  • 在右上方顯示一個(gè)Top 按鈕,點(diǎn)擊后回到文章頂部

3.4 目前的配置大集合

{
    "title": "項(xiàng)目文檔記錄",
    "description": "項(xiàng)目文檔記錄",
    "language": "zh",
    "plugins": [
        "prism",
        "-highlight",
         "simple-page-toc",
         "navigator"
    ],
    "pluginsConfig": {
        "simple-page-toc": {
            "maxDepth": 3,
            "skipFirstH1": true
       }
    }
}

4. 使用文檔編輯器

GitbookEditor

GitBook 官方出品 ,下載鏈接 GitbookEditor,如果不熟悉基本的git命令,那么最好使用這個(gè)

Sublime Text

參考:Windows上使用Sublime編輯markdown并預(yù)覽
另外提下Sublime 有個(gè)Open Folder 功能,可以在左側(cè)顯示目錄樹,更方便的是可以在增加文件目錄,重命名文件目錄

工作流程:
Sublime中修改 -- gitbook serve 預(yù)覽 -- git add .git commit -m "msg" 提交 -- git push 推送

5. 編輯(Markdown語法)

傳送:
Markdown

  • 代碼高亮
    指定代碼語言-添加ruby 指定語言為ruby
    ```ruby
      require 'redcarpet'
      markdown = Redcarpet.new("Hello World!")
      puts markdown.to_html 

參考

gitbook 安裝配置官方文檔

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Swift版本點(diǎn)擊這里歡迎加入QQ群交流: 594119878最新更新日期:18-09-17 About A cu...
    ylgwhyh閱讀 26,026評(píng)論 7 249
  • WebSocket-Swift Starscream的使用 WebSocket 是 HTML5 一種新的協(xié)議。它實(shí)...
    香橙柚子閱讀 24,735評(píng)論 8 183
  • 今天早上繼續(xù)調(diào)教。中午的時(shí)候開車來到了番禺,繼續(xù)調(diào)教,感覺這2天就是吃,調(diào)教。 晚飯弄的9點(diǎn)才去吃,吃了4人大餐,...
    DeathKnightR閱讀 142評(píng)論 0 0
  • 即使我們的生活目前看起來糟糕透頂,只要我們有心,就能發(fā)現(xiàn),生活的美好,正在不經(jīng)意的小角落里向我們招手 稍有寒意的清...
    云卿若閱讀 500評(píng)論 2 10
  • 一個(gè)人的朝圣,初印象里,你是圣經(jīng),后來才慢慢把你讀成一部小說。 哈羅德努力回憶自己有沒有試過和戴維在碼頭邊吃過雪糕...
    Liquid2016閱讀 396評(píng)論 8 1

友情鏈接更多精彩內(nèi)容