gitbook 入門教程之自定義不同的多語言首頁插件

時間 2019-12-16

標籤 gitbook 入門教程自定義不同多語言首頁插件欄目 Git 简体版

原文原文鏈接

自定義多語言主頁html

中文 | Englishgit

🏠 主頁

Github : snowdreams1006.github.io/gitbook-plu…
GitLab : snowdreams1006.gitlab.io/gitbook-plu…
Gitee : snowdreams1006.gitee.io/gitbook-plu…

屏幕截圖

用法

步驟＃1 - 更新 `book.json` 文件

在您的gitbook的 book.json 文件中，將 multilingual-index 添加到 plugins 列表中。
在 pluginsConfig ，將 enableSuper 設置爲 false 可禁用默認主頁，並添加 index值以自定義多語言主頁。僅支持相對路徑。

這是最簡單的示例：github

{
    "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": false,
            "index":"index.html"
        }
    }
}
複製代碼

有關更多詳細信息，請參考如下配置項：web

"enableSuper": {
  "type": "boolean",
  "title": "inherit from super",
  "required": false,
  "default": true
},
"index": {
  "type": "string",
  "title": "default index path",
  "required": false
}
複製代碼

步驟＃2 - gitbook命令

運行 gitbook install 。它將自動爲您的 Gitbook 安裝 multilingual-index gitbook 插件。僅須要一次。

gitbook install
複製代碼

或者您能夠運行 npm install gitbook-plugin-multilingual-index 來本地安裝。npm

npm install gitbook-plugin-multilingual-index
複製代碼

像往常同樣構建您的書（ gitbook build ）或服務（ gitbook serve ）。

gitbook serve
複製代碼

示例

官方文檔配置文件

github.com/snowdreams1…json

{
    "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": false,
            "index":"index.html"
        }
    }
}
複製代碼

官方示例配置文件

github.com/snowdreams1…bash

{
    "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": true,
            "index":"index.html"
        }
    }
}
複製代碼

繼承默認主頁的示例 `book.json` 文件

{
   "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": true,
            "index":"index.html"
        }
    }
}
複製代碼

不繼承默認主頁的示例 `book.json` 文件

{
    "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": false,
            "index":"index.html"
        }
    }
}
複製代碼