npm 包 pagedown-htmljs 使用教程

阅读时长 4 分钟读完

介绍

pagedown-htmljs 是一个将 Markdown 转化为 HTML 的 JavaScript 库。它封装了 Pagedown,并在其基础上实现了更多功能,例如代码高亮、表格、列表等。pagedown-htmljs 采用了轻量级设计,易于使用,是前端开发中的一项很好的工具。

本文将介绍如何使用 pagedown-htmljs 来将 Markdown 转化为 HTML 并进行展示。

安装

使用

API

  • Converter: 用于将 Markdown 转化为 HTML 的实例
  • getSanitizingConverter: 返回一个可进行 XSS 防护的转换器
  • Preview: 用于呈现转换后的 HTML 的组件

代码

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

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

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

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

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

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

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

示例

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

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

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

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

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

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

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

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

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

输出结果:

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

总结

pagedown-htmljs 是一个非常实用的 JavaScript 库,它可以帮助我们将 Markdown 转化为 HTML,并实现了更多的功能。本文介绍了 pagedown-htmljs 的安装、使用以及 API,同时给出了代码示例。希望本文可以对各位读者有所帮助,也希望大家能够善加利用 pagedown-htmljs。

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

纠错
反馈