npm 包 apos-snippets-comments 使用教程

阅读时长 4 分钟读完

什么是 apos-snippets-comments?

apos-snippets-comments 是一个适用于 ApostropheCMS 的 npm 包,用于在编辑器中添加评论块。

安装 apos-snippets-comments

首先,你需要确保在 ApostropheCMS 项目中已经安装了 apostrophe-workflowapostrophe-editor-2,然后执行以下命令来安装 apos-snippets-comments:

如何使用 apos-snippets-comments

在你的 app.js 文件中,将 apos-snippets-comments 添加到插件数组中:

这个模块实现了一个 apostrophe-editor-2 的功能,所以你需要在模板中使用 data-apos-editor 来启用它。你需要在设置编辑器的选项中,添加一个名为 snippetsComments 的数组,并传入你想要的注释块配置。示例:

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

这将在编辑器中添加一个名为“Snippets”的按钮。点击它打开弹出层,然后选择“Comments”选项卡,这里将会展示配置项中指定的评论块内容。

开始使用

现在你已经安装并启用了 apos-snippets-comments,尝试使用它来添加评论块吧。

下面是如何使用 apos-snippets-comments 来添加评论块的示例代码:

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

这将在编辑器中添加一个名为“Comments”的块,其中包含指定类型的评论项。保存并刷新页面即可生效。

总结

使用 apos-snippets-comments,可以轻松地在 ApostropheCMS 中添加评论块。只需几个简单的步骤,就可以轻松地集成到你的项目中。

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