简介
jstransformer-marked 是一个 npm 包，它允许我们在 Node.js 或浏览器环境中将 markdown 转换为 html。本篇文章将会介绍安装与使用 jstransformer-marked 的详细过程。
安装
使用 npm 安装 jstransformer-marked：
npm install jstransformer-marked --save
依赖
此包需要依赖于 jstransformer、marked。jstransformer 在 npm 中已经非常流行，如果你没有使用过，建议先学习一下。同时，需要了解 marked 的基本使用。
npm install jstransformer --save npm install marked --save
快速开始
使用 jstransformer-marked 的方法很简单：
const jstransformer = require('jstransformer'); const marked = require('jstransformer-marked'); const html = jstransformer(marked).render('# Hello World'); console.log(html); // <h1 id="hello-world">Hello World</h1>
通过使用 JSTransformer 的 render() 方法，我们可以轻松地将 markdown 转换为 HTML。
需要注意的是，在使用之前我们需要先引入 jstransformer 和 jstransformer-marked。
具体应用
在 Express 中使用
在 Express 中使用 jstransformer-marked 很容易。我们可以使用 app.set() 把 jstransformer-marked 中间件配置成 Express 程序的默认模板引擎。
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------- - ------------------------- ----- ------ - -------------------------------- ----- --- - ---------- -- ------ ---------------- ----------- ------------- -------- ------ ---------------- ------ -------- --------- -- - ----- --- - ------------- - ----------- -- ------------ - --------------------- -------- - --------------------- -------- ----- ---- - ---------------------------------- ------ -------------- ------ --- -- -------- ---------------------------------- ------------ ----- ---- -- - -------------------- --- ---------------- -- -- - ---------------- --------- -- ---- -------- ---展开代码
app.engine('md', ...) 方法中的处理方法与我们前面介绍的方法类似，只是最后我们将转换后的 HTML 传递了给了 res.render()。这样我们就可以在 Express 项目中使用 jstransformer-marked 了。
在 Gulp 中使用
在许多场景中，使用 gulp 来处理 markdown 是非常好的。我们只需要使用 JavaScript 来嵌入 Gulpfile 中就可以完成转换任务。我们可以使用 vinyl-fs 来读取文件，然后使用 jstransformer-marked 转换文件。
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------------- - ------------------------- ----- ------ - -------------------------------- ----- --- - -------------------- --------------------- -- -- - ----------------------- -------------------------- --------------------------- --- -------- ---------------------- - ------ -------------------------- ---- --------- - ----- --- - ------------------------------- ----- ---- - ------------------------ ------------- - ----------------- -------- ---------------- ----------- --- -展开代码
我们可以在 Gulpfile 中使用 jstransformer 和 jstransformer-marked，然后使用 vinyl-fs 来读取文件。通过使用 Gulp，我们可以使用一种非常优雅的方式解决 markdown 转换为 HTML 的问题。
总结
在本篇文章中，我们介绍了如何使用 jstransformer-marked 在 Node.js 或浏览器环境中将 markdown 转换为 HTML。我们讨论了它的基本使用和具体应用，并且介绍了如何在 Express 和 Gulp 中使用 jstransformer-marked。如果你正在使用 markdown，那么 jstransformer-marked 绝对是一个强大而灵活的选择，它可以帮助你快速地实现 markdown 转换为 HTML。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/61137
