在开发 Web 应用程序的过程中，文档编写和管理是非常重要的一环。其中，gitbook 是一款以 Markdown 格式编写文档，并能够将其发布成电子书或者静态网站的工具。而gitbook-plugin-notocjk 则是一款通过扩展 gitbook 多语言插件的方式来为 gitbook 添加中文的文档目录的插件。
安装 gitbook-plugin-notocjk
要使用 gitbook-plugin-notocjk，首先需要安装 gitbook。
npm install gitbook-cli -g
等到 gitbook 安装完成之后，就可以使用下面的命令来安装 gitbook-plugin-notocjk。
npm install gitbook-plugin-notocjk --save-dev
安装完毕后，在 GitBook 的配置文件 book.json 中配置插件即可。示例：
{
"plugins": ["notocjk"]
}配置选项
gitbook-plugin-notocjk 提供了以下的配置选项:
- default：指定默认语言的目录名，默认为 en。
- languages：指定多语言目录的名称和语言，例如："en": "English"，其中 "en" 是目录名称，"English" 是语言名。
下面是一个完整的示例配置：
-- -------------------- ---- -------
-
---------- -
---------------
--
---------------- -
---------- -
---------- ----------
------------ -
----- ----------
---------- ------
-
-
-
-其中，"default" 指定了默认的目录名为 zh-hans，而 "languages" 用于指定多语言目录的名称和对应的语言显示名称。
使用示例
下面是一个使用 gitbook-plugin-notocjk 插件的示例。
-- -------------------- ---- ------- - ------- -- -- -- ---- ------- -------------- - ----- --------------------- - ------- ------- --------------- - ----- ------- - ----------------------- - ----- ------- ------------------- - ----- ------- ---------------- -- ---- --------- ------- ------------ - -------- -------------------------------- - -------- ------ -----------------------------------------
在文章结尾处的book.json 配置如下：
-- -------------------- ---- -------
-
---------- -
---------------
--
---------------- -
---------- -
---------- ----------
------------ -
----- ----------
---------- ------
-
-
-
-该示例中，我们在目录下添加了默认语言的 zh-hans，并用中文名称表示。同时，我们也可以将 English 中文名称表示为英文名称，以便在目录中更好地标示不同语言。
总结
gitbook-plugin-notocjk 的加入为 GitBook 的多语言文档编写提供了很大的便利，同时也说明了 npm 包与开源项目间的互动，如何协作共同推进前端领域的发展。通常，我们可以通过使用 npm 包来提高我们的工作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005601181e8991b448ddfbe