npm 包 gitbook-plugin-page-flag 使用教程

阅读时长 4 分钟读完

GitBook 是一个基于 Node.js 的静态网站生成器,它使用 Markdown 语言来编写文档,并可以将文档生成静态网站。

其中,GitBook 插件可以拓展 GitBook 的功能,而 gitbook-plugin-page-flag 插件是一款可以为页面添加标记的插件。

在本篇文章中,我们将详细介绍 gitbook-plugin-page-flag 的安装和使用方法,并包含示例代码。

安装

使用 npm 安装 gitbook-plugin-page-flag 插件:

使用

添加插件

book.json 文件中添加插件:

添加标记

在 Markdown 文件中添加标记,格式为:

其中,type 为标记的类型(例如 tipwarninginfodanger 等),text 为标记的文本。

例如:

自定义

可以在 book.json 文件中自定义标记的样式,例如:

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

其中,classesstyles 分别为标记的 CSS 类和样式;types 为自定义的标记类型及其样式。

示例代码

book.json 文件:

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

Markdown 文件:

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

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

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

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

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

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

效果如下:

意义和总结

gitbook-plugin-page-flag 插件可以为 GitBook 页面添加标记,使页面内容更具有可读性和可操作性。

通过本篇文章的介绍,我们了解了插件的安装和使用方法,以及如何自定义标记的样式和类型。

希望本篇文章能够对前端开发者有所帮助。

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

纠错
反馈