Markdown 是一种轻量级标记语言,常用于编写博客、文档等。而在前端开发中,我们通常需要将 Markdown 转换成 HTML 来展示在网页上。这时候,一个常用的工具就是 markdown-to-html
这个 npm 包。
安装
在使用 markdown-to-html
前,我们首先要安装它。通过 npm 可以很方便地完成安装:
npm install markdown-to-html
使用
接下来我们就可以开始使用了。在代码中引入 markdown-to-html
,然后调用 markdown.toHTML
方法即可将 Markdown 转换成 HTML。
const markdown = require('markdown-to-html'); const markdownContent = '# Hello, world!'; const htmlContent = markdown.toHTML(markdownContent); console.log(htmlContent);
上面的代码输入如下所示:
<h1>Hello, world!</h1>
可以看到,我们成功地将 Markdown 转换成了 HTML。
高级用法
markdown-to-html
同时还支持许多高级用法,并且提供了很多自定义选项。以下是一些常用的选项:
gfm
:启用 Github Flavored Markdown 语法;sanitize
:将 HTML 标签转换为实体,防止 XSS 攻击;tables
:支持表格语法;breaks
:支持换行符;smartLists
:支持自动编号。
我们可以将这些选项传递给 markdown.toHTML
方法:
-- -------------------- ---- ------- ----- -------- - ---------------------------- ----- --------------- - - - ------ ------ ---- -- - ------ ---------- -- ---- - ---- - - ---- - -- ----- ----------- - -------------------------------- - ---- ----- --------- ----- ------- ----- ------- ----- ----------- ---- --- -------------------------展开代码
上面的代码输出如下所示:
-- -------------------- ---- ------- ---------- ----------- ------- -- - ------ -------------- ------------- ---- -------- ------ -------- ------ -----展开代码
总结
markdown-to-html
是一个简单易用、功能强大的 Markdown 转 HTML 工具。通过本文,我们了解了它的基本使用方法和一些高级选项。在实际开发中,可以根据需求选择相应的选项,并根据需要进行自定义配置,以实现更加丰富和灵活的 Markdown 转换。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/54115