GitBook的使用方法


---恢復內容開始---

由於近期工作中使用gitbook編寫講義,現把出現的問題總結下:

1 . gitbook的安裝

Gitbook與word等辦公軟件類似,能夠編寫文檔,Gitbook中編寫文檔時使用的Markdown格式,可以提交到gitHub上進行版本管理,我使用的組合是gitbook+Typora+git完成整個內容的編寫工作。

Gitbook 是基於 Node.js,所以我們首先需要安裝 Node.js(下載地址:https://nodejs.org/en/download/),找到對應平台的版本安裝即可。

現在安裝Node.js會默認安裝npm(node包管理工具),所以不用單獨安裝 npm,打開命令行,執行以下命令安裝 GitBook:

npm install -g gitbook-cli

安裝后,就會有一個gitbook命令,就可以使用這個命令來創建書籍。

書籍內容的編輯使用的是Typora,在網上找到安裝包后,安裝即可使用。

git是版本管理工具,大家應該都很熟悉,就像托管代碼一樣,托管我們的書籍即可。

2 . 書籍的創建

在你要創建書籍的文件夾下打開終端窗口,比方說是firstbook,執行下述命令:

gitbook init  

執行完以上代碼后,會在文件夾中產生兩個文件:readme.md和summary.md

 

readme文件中是書籍的介紹內容,這個根據您的需求編寫。

summary中是書籍的目錄結構,現在我們就是用Typora編輯這個文件,其中的內容為:

* [Introduction](README.md)

* [1. 季節](季節/ReadMe.md)
  * [1.1 春](季節/section0.md)
  * [1.2 夏](季節/section1.md)

* [2. 城市](城市/ReadMe.md)
  * [1.1 北京](城市/section0.md)
  * [1.2 上海](城市/section0.md)

然后,我們執行gitbook init來中心初始化這本書籍,這是我們看下結果:

 

 文件夾中就生成了各個章節對應的文件,我們就可以在這些文件中寫入相應的內容。

書籍寫完之后使用

gitbook serve

生成html的文件即可,

也可使用:

gitbook build

來生成書籍。

3 生成書籍后遇到的問題:

  1 ,點擊目錄,無法到達對應的位置:

  找到gitbook目錄下的thema.js文件:

 

 找到其中的if(m)for(n.handler&&並將其中的m修改為false即可。

 

2. 目錄無法折疊,無法改變其寬度,code無法復制等

 

在 summary.md目錄中添加一個book.json,然后在其中添加以下內容:

{
    "title": "opencv",
    "output.name": "site",
    "language": "zh-hans",
    "gitbook": "3.2.3",
    "root": ".",
    "plugins": [
        "code",
        "splitter",
        "chapter-fold"
    ],
    "pluginsConfig": {
        "code": {
            "copyButtons": true
        }
    }
}

  

 並運行gitbook install 即可。

 

 

 

---恢復內容結束---


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM