npm 包 gitbook-plugin-code3 使用教程

阅读时长 2 分钟读完

在前端领域,GitBook 是一个非常流行的文档编写和发布工具,而 npm 则是前端开发中包管理和依赖管理的主要工具之一。而 npm 包 gitbook-plugin-code3 则是一个用来美化 GitBook 中代码片段渲染的插件。

安装插件

首先,需要确保已经安装了 GitBook,然后在 GitBook 的根目录下执行以下命令:

配置插件

接下来需要在 GitBook 的 book.json 文件中配置插件,具体配置如下:

-- -------------------- ---- -------
-
  ---------- --------
  ---------- -
    -------
    ----------------------
  --
  ---------------- -
    -------- -
      -------- ----------
      ----------- ------
      ------------ ----
    -
  -
-

我们可以看到,这里配置了 codegitbook-plugin-code3 两个插件,并在 pluginsConfig 中对 gitbook-plugin-code3 进行了相关配置。

其中,theme 表示主题,这里使用了 monokai,可以根据需求修改。linenums 表示是否显示行号,这里设置为 false 表示不显示。clipboard 表示是否启用剪切板功能,这里设置为 true 表示启用。

使用插件

完成配置之后,我们就可以开始在 GitBook 中使用插件了。只需要在 Markdown 中加上代码块,例如:

-- -------------------- ---- -------

------------

-- --

---------------- --- - -------------------- --- ------- --------------------------------------------- ------- --- -------------------- ----------

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈