npm 包 jstransformer-marked 使用教程

简介

jstransformer-marked 是一个 npm 包,它允许我们在 Node.js 或浏览器环境中将 markdown 转换为 html。本篇文章将会介绍安装与使用 jstransformer-marked 的详细过程。

安装

使用 npm 安装 jstransformer-marked:

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

依赖

此包需要依赖于 jstransformer、marked。jstransformer 在 npm 中已经非常流行,如果你没有使用过,建议先学习一下。同时,需要了解 marked 的基本使用。

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

快速开始

使用 jstransformer-marked 的方法很简单:

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

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

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

通过使用 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


猜你喜欢

  • npm 包 event-pubsub 使用教程

    在前端开发中,经常会出现多个组件需要进行相互通信的情况。这时候,我们可以通过发布/订阅模式来解决问题。具体来说,就是通过一个中间件来实现组件之间的通信。event-pubsub 就是这样一个中间件,它...

    6 年前
  • npm 包 node-ipc 使用教程

    介绍 node-ipc 是一个用于建立 Node.js 进程间通信的 npm 包。该包可以在本地或者网络上进行通信,支持多进程通讯,同时实现了诸多高级功能,例如进程间互斥锁、事件监听、广播等。

    6 年前
  • npm 包 async-task-mgr 使用教程

    在前端开发中,经常会遇到需要在页面中进行异步操作的需求。而异步操作往往需要对多个任务进行控制和管理。这时候,我们可以使用 async-task-mgr 这个 npm 包来帮助我们管理异步任务,提高代码...

    6 年前
  • NPM 包 node-powershell 使用教程

    当前在前端开发中,node.js 已经成为了非常重要的技术,而 npm 包则是 node.js 最重要的组成部分之一。无论是想要在前端使用什么技术,都能够从 npm 中寻找到适合的包,而 node-p...

    6 年前
  • npm 包 node-easy-cert 使用教程

    在前端开发过程中,我们总会遇到需要创建证书来启用 HTTPS 的场景。但是,创建证书的过程通常很繁琐,需要通过 OpenSSL 生成自签名证书或者购买经过验证的商业证书。

    6 年前
  • npm 包 webpack-simple-progress-plugin 使用教程

    前言 在前端开发中,我们难免会使用到 webpack 工具来进行打包和构建等工作。而在构建的过程中,生成构建进度的提示信息对我们了解构建情况和调试错误等都十分重要。

    6 年前
  • npm 包 webpack-plugin-import 使用教程

    在基于 Webpack 构建的前端项目中,通常需要引入各种第三方库和组件。但是,如果每个页面都需要手动引入相同的库和组件,会导致代码冗余和难以维护。为了解决这个问题,我们可以使用 Webpack 插件...

    6 年前
  • npm 包 react-markdown-reader 使用教程

    介绍 react-markdown-reader 是一个 npm 包,用于在 React 项目中将 markdown 格式的文本渲染成 HTML,并提供了一系列自定义的渲染功能。

    6 年前
  • npm 包 bannerjs 使用教程

    在前端开发中,常常需要用到轮播图等常见的展示组件。而 bannerjs npm 包提供了一个简单易用的解决方案。本文将详细介绍如何使用 bannerjs 包来创建令人惊叹的幻灯片展示,并且包含深度讲解...

    6 年前
  • npm 包 colors-cli 使用教程

    在前端开发中,我们需要时常在控制台输出一些信息,比如调试信息、错误信息等等。这时我们通常会使用 console.log() 方法,但是输出的信息只是单调的黑色字体,不够直观和生动。

    6 年前
  • npm 包 zenjs-test 使用教程

    1. 前言 在前端项目开发过程中,代码质量和测试非常重要。为了方便测试,我们可以使用 npm 包 zenjs-test。它提供了一系列测试工具,可以帮助我们快速编写单元测试和集成测试。

    6 年前
  • npm 包 say 使用教程

    在前端开发中,我们通常需要使用一些工具来简化代码编写过程,提高开发效率。 npm 是一个非常强大的包管理工具,其中有许多优秀的 npm 包可供使用。本文将介绍一个常用的 npm 包:say,它可以将文...

    6 年前
  • npm 包 memserver 使用教程

    在前端开发中,数据模拟是一个非常常见的需求,特别是在前后端分离的架构中。这时,我们需要一个方便快捷的方式来模拟数据,而 npm 包 memserver 就是一个非常好用的工具。

    6 年前
  • npm 包 mber-head 使用教程

    简介 mber-head 是一个 npm 包,提供了在前端应用中方便地添加 meta 标签的功能。在开发前端应用时,通常需要添加一些 meta 标签来描述页面的标题、关键词、描述、作者等信息。

    6 年前
  • npm 包 mber 使用教程

    介绍 Mber 是一个基于 Ember.js 的轻量级应用框架,也可以用于快速搭建现代化的 Web 应用程序。Mber 提供了许多 Ember.js 没有提供的功能,例如零配置路由、热加载、快速启动等...

    6 年前
  • npm 包 amd-parallel-optimizer 使用教程

    简介 在前端开发中,我们经常需要使用异步模块定义(AMD)来管理 JavaScript 模块。然而,当我们在页面中使用大量 AMD 模块时,加载时间和渲染时间都会变长。

    6 年前
  • 聊聊 Timing-Allow-Origin 和 Access-Control-Expose-Headers

    在前端开发中,CORS(跨域资源共享)是一个常见的问题。而当我们需要对跨域请求进行控制时,Timing-Allow-Origin 和 Access-Control-Expose-Headers 是两个...

    6 年前
  • npm 包 aurelia-binding 使用教程

    前言 如今前端框架众多,其中 AngularJS 、React、Vue 等都拥有广泛的用户群体,但是还有一些小众框架同样备受青睐。其中就包括了 aurelia-binding 这个小巧却强大的 npm...

    6 年前
  • npm 包 aurelia-templating 使用教程

    简介 aurelia-templating 是一个针对 aurelia 框架的 npm 包,提供了一组可以用于构建 HTML 模板和视图的基础类和方法。 通过引入 aurelia-templating...

    6 年前
  • npm 包 aurelia-task-queue 使用教程

    在前端开发中,异步任务的处理是一个很常见的需求,它们有时候需要按照某个特定的执行顺序进行,而有时候又需要同时执行多个任务。无论是哪种情况,都需要我们合理地处理任务队列,以确保任务的正确性和高效性。

    6 年前

相关推荐

    暂无文章