简介
@ekiras/markdown-it 是一个用于 Node.js 和浏览器的 Markdown 解析器。该包基于markdown-it和highlight.js开发而成，具有很多定制的选项和插件。在前端开发中，我们常常需要将 markdown 文本解析成标准的 HTML 页面，@ekiras/markdown-it 可以完美地胜任这项工作。
安装
我们可以使用 npm 命令来安装该包：
npm install @ekiras/markdown-it highlight.js
其中，@ekiras/markdown-it 是我们要安装的包名，highlight.js 是该包所依赖的另一个包。
使用
以下是一个简单的示例：
-- -------------------- ---- -------
----- -- - --------------------------------
----- -----
-------- -----
------------ -----
---------- -------- ----- ----- -
-- ----- -- ----------------------- -
--- -
------ ----- ----------------------------------------- ---- ---------------------------
- ----- ---- --
-
------ ----- -------------------------------------------------------------
-
---
----- ------ - ------------ ----- -----------
--------------------解析后会输出以下结果：
<h1>Hello <em>world</em>！</h1>
通过运行以上示例，我们可以看出 @ekiras/markdown-it 的主要用途是将 markdown 文本转换为 HTML 标记。
语法
@ekiras/markdown-it 提供了完整的 markdown 语法支持，包括：
标题
# h1 ## h2 ### h3 #### h4 ##### h5 ###### h6
粗体和斜体
**bold** *italic*
分割线
---
引用
> Here is a quote.
列表
无序列表：
- Item1 - Item2 - Item3
有序列表：
1. Item1 2. Item2 3. Item3
代码块
inline code：
`let x = 1`
代码块：
``` javascript let x = 1; console.log(x);
### 表格
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
-- -------------------- ---- -------
---- -------- --------------- -------- -----
-- ----
----------------------
---- ----
---- ---- ------- -------------- ------
---- ------
------------- -------------- ------
---- -------
---- --- - -------- -------------- ------
---- -----------
----------------------------------------------------- -------------- ------
---- ---------
------------------------------
-- ----
-----------------------
-------------
----- -- - --------------------------------
----- -----
-------- -----
------------ -----
---------- -------- ----- ----- -
-- ----- -- ----------------------- -
--- -
------ ----- ----------------------------------------- ---- ---------------------------
- ----- ---- --
-
------ ----- -------------------------------------------------------------
-
---
----- ------ - -----------
- ----- --------
---- -- -- ------- -- ---------
--------
--------
---
- ---- -- - ------
---
--- -----
----------
- -----
- -----
- -----
--------
-- -----
-- -----
-- -----
--- ----
------ ----- ----- - - ---
---- ------
----------------
--- - - --
---------------
------
--- -----
- ------ - --- - ---- -
- ------------- ----------------- -------
- --- - -- - ------------- - ----- -
- --- - -- - -------- - --- -
----- ---- ------- ---- ------------------------
---
--------------------输出结果：
-- -------------------- ---- ------- --------- -------------------- ------- -- -- ------- -- ------------- ---------------------------- ---------------------- ---- ------------ ------- -- - ---------- ------------- ---- -------------- ----------------- ---- -------------- -------------- -------------- ----- --------------- ---- -------------- -------------- -------------- ----- ------------- --------- ----- --------- - - ------------ ------- ---------- ---- ------------------------ ------------------------------- - - ----- ----------------------------- ----- -------------------------------------------- ------------- -------------- ------- ------- ---- --------------- ------------ ------------- ----- -------- ------- ---- ------- - ------- --- ------------------------------------------- --- ----------------------------------- ----- ---- ------- - ------- --- --------------------------------------- --- --------------------------------- ----- -------- -------- -------- ---- ------- ---- -----------------------------------------
总结
@ekiras/markdown-it 提供了非常强大的 markdown 转换功能，可以帮助前端工程师处理 markdown 文本，并将其解析为标准的 HTML 标记。在实际应用中，我们可以根据需要进行定制，以便更好地满足业务需求。同时，@ekiras/markdown-it 还为我们提供了丰富的 API，可以更好地支持扩展和二次开发，我们有必要深入研究其原理并加以应用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005779b81e8991b448eada3