npm 包 gitbook-plugin-tech-radar 使用教程

阅读时长 5 分钟读完

简介

该 npm 包为 GitBook 提供了一个名为“技术雷达”的插件,可以用于显示一个技术雷达图,根据技术的成熟度和评估结果,把技术分为四个象限。

安装

首先,我们需要安装 GitBook 并创建一个新的 GitBook 项目。接下来在项目根目录下安装技术雷达插件:

安装完成后,我们需要在 GitBook 的 book.json 文件中添加以下代码:

配置

在 book.json 中,我们还需要为技术雷达图配置相关参数。下面是一个示例配置:

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

参数说明

上述配置中,我们为技术雷达图定义了四个象限(quadrants),每个象限有一个标题和一个颜色(使用 CSS 颜色代码表示)。我们还定义了四个技术条目(entries),每个条目都包含以下属性:

  • name(必填):技术名称。
  • quadrant(必填):该技术所属的象限。
  • level(必填):该技术的成熟度,可选值为 adopt、trial、assess 和 hold。
  • description(可选):该技术的简要描述。

示例说明

在上述示例中,我们定义了四个技术条目,分别为 Angular.js、Webpack、TypeScript 和 WebAssembly。其中 Angular.js 归属于框架象限,属于 adopt 成熟度;Webpack 归属于工具象限,属于 trial 成熟度;TypeScript 和 WebAssembly 归属于语言与平台象限,分别属于 assess 和 hold 成熟度。

总结

使用 npm 包 gitbook-plugin-tech-radar 可以方便地为 GitBook 项目添加技术雷达图。通过配置文件,我们可以定义技术象限和技术条目,并根据实际情况进行调整。技术雷达图可以帮助我们了解技术的成熟度和评估结果,指导我们在实际项目中进行技术选型和决策。

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

纠错
反馈