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

自定義多語言主頁

中文 | 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 文件

1. 在您的gitbook的 book.json 文件中，將 multilingual-index 添加到 plugins 列表中。
2. 在 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命令

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

gitbook install

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

npm install gitbook-plugin-multilingual-index

1. 像往常一樣構建您的書（ 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"
        }
    }
}

作者

👤 snowdreams1006

• 網站： snowdreams1006.tech
• GitHub ： @ snowdreams1006
• 電子郵件： [email protected]

貢獻

歡迎提供文稿，問題和功能請求！

隨時檢查問題頁面 。

表示支持

如果這個項目對您有幫助，請給個**星星** ！

版權

版權所有©2019 snowdreams1006 。

該項目是MIT許可的。

如果你覺得本文對你有所幫助,請隨手點個贊再走唄或者關注下公衆號「雪之夢技術驛站」定期更新優質文章喲!