现在的前端开发中，经常需要使用文档来帮助我们更深入地了解前端框架、库、方法等。而 GitBook 作为一种流行的文档写作工具，能够帮助前端开发者将技术文档维护得更为规范，同时也能够向其他开发者分享自己的经验。
在 GitBook 中，我们常常使用 code 标签来展示代码块。但是，有时候我们不希望某些代码块被缓存到浏览器缓存中，而 GitBook 自动生成的 Glossary 功能也会导致一些困扰。
这时， gitbook-plugin-codeblock-disable-glossary 这个 npm 包就能帮助我们解决这些问题。接下来，我们将详细讲解如何使用这个 npm 包。
安装
由于 gitbook-plugin-codeblock-disable-glossary 是一个 GitBook 插件，我们需要将其安装到项目中：
npm install --save gitbook-plugin-codeblock-disable-glossary
或者，在你的 book.json 文件下的 plugins 下添加以下内容：
{
"plugins": [
"codeblock-disable-glossary"
]
}在使用之前，我们需要了解该插件的几个使用方法。
使用方法
禁用 code 缓存
通过添加 data-nocache 属性实现禁用 code 缓存：
<code data-nocache>
// 这段代码将不会被缓存到浏览器中
</code>禁用 code 自动转换为 Glossary
通过添加 data-glossary-disabled 属性实现禁用 code 自动转换为 Glossary：
<code data-glossary-disabled>
// 这段代码不会再转换为 Glossary
</code>禁用 code 缓存且禁用自动转换为 Glossary
如果你想要同时禁用上述两个功能，只需要将 data-nocache 和 data-glossary-disabled 属性同时添加到 code 标签中即可。
<code data-nocache data-glossary-disabled>
// 这段代码不会被缓存，也不会转换为 Glossary
</code>修改插件配置
如果你觉得默认配置不够满足你的需求，你可以通过修改插件配置文件实现自定义功能。
在 GitBook 项目的根目录下，新建一个名为 book.js 的文件，并添加以下内容(其中 itemArrayKey 可以指定不缓存的 key 的名称)：
module.exports = {
pluginsConfig: {
"codeblock-disable-glossary": {
"itemArrayKey": "_items"
}
}
};示例代码
下面是一个示例，演示如何禁用代码被缓存并禁用自动转换为 Glossary：
<h1>示例代码</h1>
<code data-nocache data-glossary-disabled>
// 这段代码不会被缓存，也不会转换为 Glossary
</code>结语
gitbook-plugin-codeblock-disable-glossary 这个 npm 包可以帮助我们更好地维护 GitBook 中的技术文档，使得文档写作更规范，更适合大规模的团队协作。
如果你在使用中遇到了问题，可以参考官方文档(https://www.npmjs.com/package/gitbook-plugin-codeblock-disable-glossary)，或者通过 GitHub(https://github.com/leohxj/gitbook-plugin-codeblock-disable-glossary) 提出问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f3365c0dbf7be33b2566ddc