Gitbook-Ext 修改Gitbook模板

Gitbook-Ext

GitBook 是一個基於 Node.js 的命令行工具，可以使用 Github/Git 和 Markdown 來製做精美的電子書，GitBook 並不是關於 Git 的教程。

GitBook 提供的的默認樣式可能不能知足您的視覺需求，Gitbook-Ext是對GitBook的擴展，並陸續會提供一些更豐富的模板選擇。

擴展功能

• 提供多種色彩模板選擇:theme-green,theme-purple,theme-orange,theme-gray;
• 提供菜單可摺疊配置;
• 提供是否生成菜單序號配置;
• 提供標題與版權信息設置。

電腦上的效果

手機上的效果

預覽效果 http://f2edocs.com/

快速開始

安裝GitBook

首先你須要先安裝nodejs/npm, 而後在安裝gitbook 經過如下命令就能夠安裝

$ npm install gitbook-cli -g

gitbook具體詳細能夠參考 https://github.com/GitbookIO/gitbook

安裝Gitbook-Ext

npm install gitbook-ext -g

查看幫助

gitbook-ext -h

會列出如下信息

Usage: index [options]

 Options:

   -h, --help      output usage information
   -V, --version   output the version number
   -d, --default   default template
   -p, --pagurian  pagurian template

使用模板

初始化模板信息

gitbook-ext -i

你也能夠手動建立如下文件

├── book.json
├── README.md
└── SUMMARY.md

book.json 這個文件能夠配置模板參數

{
    "variables": {
        "title": "前端工程師文檔",
        "theme": "theme-gray",
        "copyright": "Copyright 2015 f2edocs.com"
    },
    "collapsible_menu":true,
    "level_number":false,
    "links": {
        "gitbook": false,
        "sharing": {
            "all":false,
            "vk": false,
            "facebook": true,
            "twitter": true,
            "google": true,
            "weibo": true
        }

    }
}

• variables-title: 配置文檔標題，顯示在頁面頂部;
• variables-theme: 模板顏色,當前支持:theme-green,theme-purple,theme-orange;
• variables-copyright: 配置版權信息，顯示在頁面底部;
• collapsible_menu: 使用摺疊菜單;
• level_number: 使用菜單結構序號;
• links: 開啓一些鏈接.

切換你須要使用的模板 好比使用pagurian模板

gitbook-ext -p

當配置完成之後，執行如下命令，就默認生成了一個_book文件

gitbook build

若是你想切換到默認的模板，執行如下命令

gitbook-ext -d
gitbook build

誰在用

http://f2edocs.com/