npm 包 marked-papandreou 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

marked-papandreou 是一个基于 JavaScript 的 Markdown 解析器，可以将 Markdown 文本转化成 HTML。

与其他 Markdown 解析器不同的是，marked-papandreou 支持 GFM（GitHub Flavored Markdown）语法，例如任务列表、表格、代码块高亮等。此外，它还支持插件机制，可以根据需要自定义解析规则。

安装

使用 npm 安装：

npm install marked-papandreou --save

使用

在 Node.js 中，可以将 marked-papandreou 模块引入并调用 marked 方法进行解析：

const marked = require('marked-papandreou');

const markdownText = '这是一段 **Markdown** 文本';

const html = marked(markdownText);

console.log(html);

在浏览器环境中，可以直接通过 <script> 标签引入：

<script src="https://cdn.jsdelivr.net/npm/marked-papandreou@2.0.3/marked.min.js"></script>

然后可以在 JavaScript 代码中使用 marked 函数进行解析：

const markdownText = '这是一段 **Markdown** 文本';

const html = marked(markdownText);

document.querySelector('#content').innerHTML = html;

高级用法

自定义解析规则

marked-papandreou 支持插件机制，可以根据需要自定义解析规则。下面是一个示例，使用 highlight.js 库为代码块添加语法高亮：

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

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

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

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

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

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

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

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

配置选项

可以通过第二个参数传入一个选项对象来配置解析器的行为。下面是一些常用选项：

gfm：启用 GFM（GitHub Flavored Markdown）语法，默认为 true。
breaks：启用换行符作为 <br> 标签输出，即支持在行末加上两个空格表示强制换行，默认为 false。
headerIds：启用自动为标题生成 ID 属性，默认为 true。
renderer：自定义渲染器。

结语

marked-papandreou 是一个功能强大、易于使用的 Markdown 解析器，支持 GFM 语法和插件机制，可以根据需要自定义解析规则。它可以用于构建静态网站、博客系统等场景。尝试使用它，你会发现它能够提高你的工作效率。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/45752