npm 包 gitbook-plugin-include-codeblock-patched 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要在文档中嵌入代码块，以便展示代码示例或者说明代码的使用方法。而 gitbook-plugin-include-codeblock-patched 是一个支持在 GitBook 文章中嵌入代码块的 npm 包，让我们在编写技术文档时更加轻松自如。

什么是 gitbook-plugin-include-codeblock-patched？

gitbook-plugin-include-codeblock-patched 是 gitbook-plugin-include-codeblock 的增强版插件。原插件只支持从文件中导入代码块，而 gitbook-plugin-include-codeblock-patched 则支持从远程 Git 仓库或者本地项目中导入代码块，方便了文档编写者进行代码块的维护。

安装和使用

安装

通过 npm 安装 gitbook-plugin-include-codeblock-patched 插件：

npm install --save-dev gitbook-plugin-include-codeblock-patched

使用

在本地项目中构建需要展示的代码块，例如：
```
// app.js
export function sum(a, b) {
  return a + b;
}
```
在 GitBook 文章中通过以下 tag 导入代码块：
```
{% includeCodeBlockPatched path="app.js" lang="javascript" %}
```
其中，path 指定了本地项目中需要展示的代码块路径，lang 指定了代码块的语言。
编译 GitBook 文章，预览效果即可。

指导意义

gitbook-plugin-include-codeblock-patched 的使用方法相对简单，但是它让我们能够更方便地在技术文档中展示代码块，让技术分享变得更加直观和易懂。在实际工作中，我们也可以通过该插件轻松地在内部文档或者公开的技术博客中发布技术文章。

示例代码

代码库：https://github.com/ruanyf/gitbook-plugin-include-codeblock-patched

app.js

export function sum(a, b) {
  return a + b;
}

GitBook 文章

{% includeCodeBlockPatched path="app.js" lang="javascript" %}

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055fc081e8991b448dd124