npm 包 meta-remarkable 使用教程

阅读时长 4 分钟读完

前言

在前端开发中,我们可能经常需要在网页中添加一些元数据(meta data)信息。这些信息包括页面标题、描述、作者等等。但是,手动在 HTML 文件中添加这些信息太过繁琐,不利于后期维护。因此,一些开发者开发了一些工具,帮助我们方便地添加和管理 meta data。

其中,meta-remarkable 是一款可以帮助我们生成 meta data 的 npm 包,本文将为大家介绍如何使用它来方便地添加和管理 meta data。

安装

我们可以使用 npm 来安装 meta-remarkable:

使用

meta-remarkable 是基于 remarkable 的插件,在使用它之前,我们需要先了解 remarkable。

remarkable

remarkable 是一款轻量级的 Markdown 解析器,主要特点是 速度极快

这里简单介绍 remarkable 的使用方法(更详细的内容请参考官方文档):

这段代码使用了 remarkable 生成了一个 md 实例,然后使用 md.render 方法将指定的 Markdown 文本渲染成 HTML 文本,并输出到控制台中。

meta-remarkable

了解了 remarkable 之后,让我们来看看如何使用 meta-remarkable。

在 HTML 中,我们可以通过添加如下代码来添加 meta data:

-- -------------------- ---- -------
--------- -----
----- ----------
  ------
    ----- ----------------
    ----- ------------- ------------- ------
    ----- ------------------ ------------- -------------
    ----------- -------------
  -------
  ------
    ---
  -------
-------
展开代码

可以看到,我们需要手动添加多个 meta 标签,其中每一个标签都需要指定属性和属性值。这样做非常麻烦,而且容易出错。meta-remarkable 就是为了解决这个问题而生的。

下面我们来看看如何使用 meta-remarkable:

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

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

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

-----------------------------
展开代码

这段代码使用了 meta-remarkable 生成了一个 md 实例,在渲染 Markdown 文本时,同时输出了对应的 meta data。其中,meta data 以 YAML 格式出现在文本的最顶部,用 --- 包围。在这个例子中,我们定义了 title、author 和 description 三个属性,并且将它们的值设置为指定的值。

渲染结果如下:

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

- ----------------------------------------------------------- --------
----------------------------------------------------------------------------------
展开代码
纠错
反馈

纠错反馈