npm 包 gitbook-plugin-highlight 使用教程

在前端开发中，常常需要使用到代码高亮展示，在 GitBook 中，我们可以使用 gitbook-plugin-highlight 插件来实现代码高亮的效果。

安装

在 GitBook 项目中安装 gitbook-plugin-highlight 插件：

npm install gitbook-plugin-highlight --save-dev

配置

配置 GitBook 的 book.json 文件，启用 gitbook-plugin-highlight 插件：

{
  "plugins": ["highlight"]
}

使用

在 Markdown 中，使用三个反引号（```）包裹代码块，并指定语言类型，如下所示：

console.log("Hello, world!");

这会将代码块中的 JavaScript 代码高亮显示。其他支持的语言类型可以在 highlight.js 的官方文档中找到。

自定义样式

如果要自定义代码高亮的样式，可以在 book.json 中添加以下配置：

{
  "pluginsConfig": {
    "highlight": {
      "theme": "github"
    }
  }
}

其中，theme 可以设置为 highlight.js 支持的主题名称，比如 "github"、"monokai" 等等。

总结

通过上面的教程，我们了解了如何使用 gitbook-plugin-highlight 插件来实现 GitBook 中的代码高亮效果，并学习了如何自定义代码高亮的样式。希望本文对您有所帮助！

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