gitbook 入门教程之自定义不一样的多语言首页插件

雪之梦技术驿站 · · 880 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

npm:version
npm:download
npm:prerequisite
github:documentation
github:maintenance
npm:license
github:snodreams1006
website:snodreams1006.tech
微信公众号:雪之梦技术驿站-brightgreen.svg

自定义多语言主页

中文 | English

???? 主页

屏幕截图

multilingual-index-use-preview.png

用法

步骤#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"
        }
    }
}

multilingual-index-use-preview.png

  • 官方示例配置文件
https://github.com/snowdreams1006/gitbook-plugin-multilingual-index/blob/master/example/book.json
{
    "plugins": ["multilingual-index"],
    "pluginsConfig": {
        "multilingual-index": {
            "enableSuper": true,
            "index":"index.html"
        }
    }
}

multilingual-index-example-preview.png

继承默认主页的示例 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

贡献

欢迎提供文稿,问题和功能请求!

随时检查问题页面

表示支持

如果这个项目对您有帮助,请给个星星

版权

版权所有©2019 snowdreams1006

该项目是MIT许可的。

如果本文对你有所帮助,不用赞赏,也不必转发,直接点赞留言告诉鼓励一下就可以啦!

雪之梦技术驿站.png


有疑问加站长微信联系(非本文作者)

本文来自:Segmentfault

感谢作者:雪之梦技术驿站

查看原文:gitbook 入门教程之自定义不一样的多语言首页插件

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

880 次点击  
加入收藏 微博
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传