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

標簽：

Node.js 前端工具開源

自定义多语言主页

中文 | English

🏠 主页

Github : https://snowdreams1006.github.io/gitbook-plugin-multilingual-index/
GitLab : https://snowdreams1006.gitlab.io/gitbook-plugin-multilingual-index/
Gitee : https://snowdreams1006.gitee.io/gitbook-plugin-multilingual-index/

屏幕截图

用法

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

在您的gitbook的 book.json 文件中，将 multilingual-index 添加到 plugins 列表中。
在 pluginsConfig ，将 enableSuper 设置为 false 可禁用默认主页，并添加 index值以自定义多语言主页。仅支持相对路径。

这是最简单的示例：

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

有关更多详细信息，请参考以下配置项：

"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 install gitbook-plugin-multilingual-index

像往常一样构建您的书（ gitbook build ）或服务（ gitbook serve ）。

gitbook serve

示例

官方文档配置文件

https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/blob/master/docs/book.json

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

官方示例配置文件

https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/blob/master/example/book.json

{
    "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"
        }
    }
}