npm 包 enb-markdown 使用教程

阅读时长 5 分钟读完

enb-markdown 是一款非常便捷的 npm 包,可以将 Markdown 文本转换为 HTML,方便前端工程师在前端编写文章。本文将详细介绍 enb-markdown 的使用教程,帮助前端工程师更快更好地使用 enb-markdown。

什么是 enb-markdown?

enb-markdown 是基于 ENB 的 Markdown 编译器,可以使用 enb-markdown 通过 npm 在打包阶段将 Markdown 文件转化为 HTML。

安装 enb-markdown

在使用 enb-markdown 前,需要先安装 Node.js 和 npm。在安装完成 Node.js 和 npm 后,可以执行以下指令来安装 enb-markdown:

使用 enb-markdown

使用 enb-markdown 的过程需要先编写 Markdown 文本,之后在编译过程中转换为 HTML。

编写 Markdown 文本

编写 Markdown 文本需要使用 Markdown 语法。具体可以参考 Markdown 教程

例如,下面是一段使用 Markdown 编写的文章:

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

-- ---

--- ---

---------

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

-------

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

enb-make 的配置

在使用 enb-markdown 时,需要先配置 enb-make。

首先,在项目根目录下创建 enb-make.js 文件,内容如下:

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

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

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

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

这样我们的 Bundle 就配置完毕了。

编译 Markdown 文件

配置完成 enb-make.js 文件后,在项目根目录执行以下指令:

至此,我们的 Markdown 文件就已经成功编译为 HTML 了。

意义与学习

enb-markdown 主要解决了在前端中处理 Markdown 文本的问题。前端工程师可以通过 enb-markdown,使用 Markdown 编写文章,并在前端中展示。

同时,使用 enb-markdown 还可以帮助前端工程师学习和掌握 Markdown 语法。

示例代码

以上效果已经足够演示使用 enb-markdown 的绝大部分内容了,这里提供完整的示例代码:

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

-- ---

--- ---

---------

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

-------

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

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

结语

本文介绍了 npm 包 enb-markdown 使用教程。使用 enb-markdown 可以方便地将 Markdown 文本转化为 HTML,帮助前端工程师更好地在前端编写文章。同时,在学习过程中也应多加练习,深入理解 Markdown 语法的使用。

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

纠错
反馈