返回

GitBook 初学者指南:自定义多语言主页插件

前端

GitBook 多语言主页自定义插件介绍

GitBook 是一个受欢迎的知识分享和在线文档发布平台。GitBook 的特点是轻量级、易于使用,并且支持多语言。如果您需要创建一个多语言的 GitBook 文档,那么您可能需要用到 multilingual-index 这个插件。

使用 GitBook multilingual-index 自定义多语言主页

multilingual-index 是一个 GitBook 插件,可以帮助您自定义多语言主页。该插件的主要功能是允许您为不同语言创建不同的主页。这可以使您的文档更易于导航,并使您的读者能够更容易地找到他们需要的信息。

1.安装 multilingual-index 插件

首先,您需要安装 multilingual-index 插件。您可以通过以下步骤安装该插件:

  1. 打开 GitBook 文档的根目录。
  2. 在根目录中创建一个名为 plugins 的文件夹。
  3. 在 plugins 文件夹中创建一个名为 multilingual-index 的文件夹。
  4. 将 multilingual-index 插件的源代码复制到 multilingual-index 文件夹中。

2.配置 multilingual-index 插件

安装好 multilingual-index 插件后,您需要对其进行配置。您可以通过以下步骤配置该插件:

  1. 打开 GitBook 文档的 book.json 文件。
  2. 在 plugins 列表中添加 multilingual-index。
  3. 在 pluginsConfig 中,将 enableSuper 设置为 false 以禁用默认主页。
  4. 添加 index 值以自定义多语言主页。

3.创建多语言主页

配置好 multilingual-index 插件后,您就可以开始创建多语言主页了。您可以通过以下步骤创建多语言主页:

  1. 在 GitBook 文档的根目录中创建一个名为 _i18n 的文件夹。
  2. 在 _i18n 文件夹中创建您需要的所有语言的子文件夹。
  3. 在每个语言的子文件夹中创建一个名为 index.md 的文件。
  4. 在 index.md 文件中,编写您想要显示在该语言主页上的内容。

4.预览多语言主页

创建好多语言主页后,您就可以预览它们了。您可以通过以下步骤预览多语言主页:

  1. 打开 GitBook 文档的根目录。
  2. 运行以下命令:
gitbook serve
  1. 在浏览器中打开 http://localhost:4000 即可预览多语言主页。

结语

以上就是使用 GitBook multilingual-index 自定义多语言主页的方法。希望本文能够帮助您轻松创建多语言的 GitBook 文档。