npm 包 wiki-plugin-federatedwiki 使用教程

阅读时长 4 分钟读完

简介

wiki-plugin-federatedwiki 是一个 npm 包,可用于在 Federated Wiki 中添加插件。Federated Wiki 是一个开源的 wiki 系统,其特点是将 wiki 页面分布式存储在多个主机上,用户可以通过多种方式协作编辑。

安装

在使用 wiki-plugin-federatedwiki 之前,需要先安装 Federated Wiki。安装 Federated Wiki 可以参考 Federated Wiki 的 官方安装指南,或者在 GitHub 页面 上查看最新的安装方法。

安装了 Federated Wiki 之后,可以使用以下命令安装 wiki-plugin-federatedwiki

使用

wiki-plugin-federatedwiki 提供了一个 plugin 函数,用户需要在 Federated Wiki 的插件配置文件中注册该函数,以便在 Federated Wiki 中使用该插件。以下是一个示例配置文件 plugins.json

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

用户需要按照实际情况修改 arg1arg2 参数的值,以便符合实际需求。还可以添加其他字段,例如 manifest 字段、dependencies 字段等,参考 Federated Wiki 插件的配置文件格式。

注意:Federated Wiki 插件的配置文件应该存储在 ./wiki/plugins.json 文件中,其中 ./wiki 是 Federated Wiki 的根目录。

示例

可以通过一个简单的示例来理解如何使用 wiki-plugin-federatedwiki

以下是一个 test.js 文件,用于实现简单的抽奖程序:

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

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

该程序可以生成一个抽奖页面,当用户点击按钮时,会有 10% 的概率中奖。

为了在 Federated Wiki 中使用该程序,可以在插件配置文件中添加以下内容:

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

在 Federated Wiki 中,可以添加一个新的页面,并将其类型设置为 Lottery。页面的内容将会是 test.js 中定义的 HTML。

总结

使用 wiki-plugin-federatedwiki 可以在 Federated Wiki 中添加自定义的插件,并实现更丰富的功能。在配置插件时需要注意参数的设置,可以通过示例来理解如何使用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/wiki-plugin-federatedwiki