npm 包 @justinc/remark-yaml-meta 使用教程

阅读时长 3 分钟读完

在前端开发的过程中,处理文档的问题是经常会遇到的。在这个过程中,你可能需要使用到 YAML 形式的元数据。这时,npm 包 @justinc/remark-yaml-meta 可以为你提供方便。

安装 @justinc/remark-yaml-meta

使用 npm,可以通过以下命令进行安装:

使用 @justinc/remark-yaml-meta

通过代码使用

你可以使用 @justinc/remark-yaml-meta 的 JavaScript API 来读取 markdown 中的 YAML 元数据。

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

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

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

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

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

通过这段代码,你可以知道如何使用 @justinc/remark-yaml-meta 读取 markdown 中的 YAML 元数据。

通过编辑器插件使用

@justinc/remark-yaml-meta 也可以同许多编辑器插件共同使用来方便地插入 YAML 元数据。以下是一些常用的编辑器插件:

  • VSCode:markdown-yaml-preamble
  • Atom:markdown-yaml-metadata
  • Sublime Text:Markdown Metadata

你可以在你所使用的编辑器的插件库中搜索到这些插件。

示例代码

以下是一个简单的示例,在 markdown 中插入 YAML 元数据:

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

- ----

---------

-- ---

----

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

-- ---

----

结论

通过本文,你已经知道了如何使用 npm 包 @justinc/remark-yaml-meta,以及如何在 markdown 文档中插入 YAML 元数据。相信在你的前端开发中,这个工具会让你更加便捷地处理文档元数据。

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

纠错
反馈