npm 包 gitbook-plugin-anchorjs 使用教程

阅读时长 2 分钟读完

什么是 gitbook-plugin-anchorjs

gitbook-plugin-anchorjs 是一个用于 GitBook 的插件,可以为文章中的标题生成锚点,并在标题上自动添加一个复制链接的按钮,方便读者复制文章中的标题链接。

如何安装 gitbook-plugin-anchorjs

使用 npm 安装 gitbook-plugin-anchorjs:

如何配置 gitbook-plugin-anchorjs

在 GitBook 的 book.json 文件中添加以下配置:

在上面的配置中,selector 用于指定需要生成锚点和复制链接的标题级别,这里选择了 h1、h2 和 h3 标题。

如何使用 gitbook-plugin-anchorjs

安装并配置好 gitbook-plugin-anchorjs 后,所有符合 selector 的标题都会自动添加上锚点和复制链接的按钮。

例如,下面是一个包含多个标题的 GitBook 示例:

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

-------

-- ---

--------

--- ---

--------

-- ---

---------

使用 gitbook-plugin-anchorjs 后,GitBook 渲染后的效果如下图所示:

读者可以点击标题后的锚点链接跳转到对应的标题位置,并点击标题后的复制链接按钮复制该标题的链接地址。

总结

gitbook-plugin-anchorjs 是一个非常实用的 GitBook 插件,可为文章中的标题自动添加锚点并生成复制链接的按钮,方便读者阅读和分享文章。使用时,需要先安装并配置好 gitbook-plugin-anchorjs,然后在书籍中适当添加需要生成锚点的标题即可。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedaa9db5cbfe1ea061052c

纠错
反馈