文档章节

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

雪之梦技术驿站
 雪之梦技术驿站
发布于 2019/12/11 17:32
字数 474
阅读 11
收藏 0

npm:version npm:download npm:prerequisite github:documentation github:maintenance

l-indenpm: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

© 著作权归作者所有

雪之梦技术驿站
粉丝 32
博文 89
码字总数 207496
作品 0
宁波
私信 提问
GitBook - 快速打造可留言的博客

Create by jsliang on 2019-05-20 14:43:41 Recently revised in 2019-05-22 18:01:09 本文将介绍如何安装 GitBook、如何起 GitBook 服务、如何配置 GitBook,以及到最后的部署到 GitHub Pag...

jsliang
2019/05/22
0
0
GitBook快速教程 1.3 电子书导出

版权声明:本文为twowinter原创文章,请联系微信公众号twowinter,未经博主允许不得转载。 https://blog.csdn.net/iotisan/article/details/81121218 这是一个 gitbook 教程,介绍如何基于模...

iotisan
2018/07/19
0
0
Gitbook-Ext 修改Gitbook模板

Gitbook-Ext GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。 GitBook 提供的的默认样式可能不能满足您的视觉...

漆工
2015/10/07
2.4K
0
开发工具总结(12)之GitBook制作文档并发布到GitHub

在线文档制作工具系列篇 ↓: 第一篇:GitBook制作文档并发布到GitHub 第二篇:制作文档并发布到GitHub 第三篇:制作文档并发布到GitHub 第四篇:制作文档并发布到GitHub 一、GitBook制作文档...

AWeiLoveAndroid
2019/07/05
0
0
用 Github、Markdown 和 GitBook 写开源书

原文同步至:http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/ 之前一直是在 Github 上写开源书(见:http://www.waylau.com/books/)但,由于 Github 本身的......

waylau
2014/12/11
11.5K
3

没有更多内容

加载失败,请刷新页面

加载更多

Numpy处理图片方法

在进行图像领域的深度学习的时候经常需要对图片进行处理,包括图像的翻转,压缩,截取等,一般都是用Numpy来处理。处理起来也很方便。 In[3] # 导入需要的包 import numpy as np import matp...

北方的郎
21分钟前
7
0
AMD集中擢升高管:从Intel挖了个高手

  1 月 17 日,AMD 官方宣布多项人事升迁、新人任命,擢升了四位高级副总裁:   AMD 同时还宣布, 聘请行业资深人士 Daniel McNamara 出任高级副总裁兼服务器业务部总经理,负责在第二代...

水果黄瓜
26分钟前
6
0
什么是泛型?

一、泛型的概念 泛型是 Java SE5 出现的新特性,泛型的本质是类型参数化或参数化类型,在不创建新的类型的情况下,通过泛型指定的不同类型来控制形参具体限制的类型。 二、泛型的意义 一般的...

hncboy
今天
7
0
dynamic-connectivity 动态连通性问题之 quick-union 算法

quick-union 的思想是:若对象 p 的 root_id 和对象 q 的 root_id 相等,则认为 p 和 q 连通。 若要将对象 p 和对象 q 连通(已知两对象未连通),则将 p 的 root_id 的值设为 q 的 root_id ...

Phpythoner_Alei
今天
51
0
OSChina 周六乱弹 —— 实在选不出来就唱国歌

Osc乱弹歌单(2020)请戳(这里) 【今日歌曲】 @花间小酌 :#今日歌曲推荐# 分享阿冗的单曲《你的答案》。--祝大家在2020年都找到自己答案。 《你的答案》- 阿冗 手机党少年们想听歌,请使劲...

小小编辑
今天
291
6

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部