npm 包 wmd 使用教程

在前端开发中，我们经常需要编辑和渲染 Markdown 格式的文本。wmd 是一个非常好用的 npm 包，提供了一系列方便的 API 和组件，帮助我们在前端中轻松地实现 Markdown 文本的编辑和渲染。本文将介绍 wmd 的使用教程，并提供详细的示例代码，帮助大家快速上手。

安装 wmd

首先，我们需要在项目中安装 wmd。可以使用 npm 命令直接安装：

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

编辑 Markdown 文本

使用 wmd 编辑 Markdown 文本非常方便。我们只需要在 HTML 页面中引入 wmd.js，然后创建一个 textarea 元素即可。

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

在上述示例代码中，我们创建了一个 textarea 元素，并使用 wmd.js 的 WMDEditor 类对其进行绑定。这样，我们就可以在 textarea 中输入和编辑 Markdown 文本了。

渲染 Markdown 文本

除了编辑 Markdown 文本，我们还需要将其渲染成 HTML。wmd 提供了一个 WMDEditor.getHTML() 方法，可以将编辑框中的 Markdown 文本转换为 HTML。

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

在上述示例代码中，我们新增了一个 <div> 元素，并将其作为 output 参数传递给 WMDEditor 构造函数。这样，当用户在 textarea 中输入 Markdown 文本后，就会自动将其转换为 HTML 并渲染到 <div> 元素中。

自定义渲染器

如果我们希望自定义渲染器，可以使用 wmd 提供的 Marked 类。Marked 类是一个流行的 Markdown 渲染工具，支持扩展和定制渲染器。

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

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

在上述示例代码中，我们创建了一个 marked.Renderer 对象，并自定义了 heading 渲染器。然后，我们将 marked.Renderer 对象传递给 WMDEditor 构造函数中的 marked 参数。

总结

以上就是使用 wmd 包在前端中编辑和渲染 Markdown 文本的完整教程。通过本文的介绍，读者可以掌握 wmd 的基本用法，并能够自定义渲染器和 Markdown 样式。如果你的项目中需要使用 Markdown，不妨试一试 wmd。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedb857b5cbfe1ea0611814

阅读全文

猜你喜欢

  • npm 包 babel-plugin-transform-titanium 使用教程

    前言 在前端开发中，我们常常需要使用新的 ECMAScript 特性来提高代码的可维护性和性能，例如箭头函数、模板字符串等等。然而，这些新特性并不是所有的浏览器都支持的，为了让我们的代码能够在各种浏览...

    4 年前
  • npm 包 bs-pretty-message 的使用教程

    本文介绍了如何使用 bs-pretty-message 这个 npm 包来美化浏览器控制台输出的信息。 什么是 bs-pretty-message？ bs-pretty-message 是一个可以美化...

    4 年前
  • NPM 包 Idyll-document 使用教程

    前言 在现今的前端开发中，很多开发者们都在使用渐进式 JavaScript 反应式应用程序的工具，其中包括我们要介绍的一个 NPM 包 - idyll-document。

    4 年前
  • npm 包 axis.js 使用教程

    前言 在进行前端开发的过程中，我们有时候需要处理数据可视化的问题。在这样的情况下，轴线是一个很好的工具，可以帮助我们在图表中调整数据的位置和比例。在这篇文章中，我们将详细介绍 npm 包 axis.j...

    4 年前
  • npm 包 @nodefony/stage 使用教程

    介绍 @nodefony/stage 是一个 Node.js 的包管理器，它允许前端的开发人员在自己的项目中方便地利用现有的第三方库和组件。 本文将详细介绍如何使用 @nodefony/stage 包...

    4 年前
  • npm 包 @nodefony/documentation-bundle 使用教程

    前言 @nodefony/documentation-bundle 是一个供前端工程师使用的 npm 包，它提供了一种简单有效的方式来生成文档和 API 参考文档，方便了前端开发对于项目的维护和升级。

    4 年前
  • npm 包 convert-hex 使用教程

    在前端开发中，颜色的使用是非常常见的，而颜色的表示方式有很多种，其中包括十六进制表示法。而针对十六进制表示法的颜色值，在 JavaScript 中有一个非常实用的 npm 包，叫做 convert-h...

    4 年前
  • npm包 @nodefony/elastic-bundle 使用教程

    介绍 @nodefony/elastic-bundle 是一款基于 Elasticsearch 的 Node.js Web 服务。它提供了一系列的工具和功能，使得开发人员能够方便高效地使用 Elast...

    4 年前
  • npm 包 @nodefony/framework-bundle 使用教程

    前言 Node.js 是一种非常流行的后端开发语言，而在 Node.js 中，npm 是一个广泛使用的包管理器。在 Node.js 应用程序的构建中，需要使用一些框架或库来加速开发过程。

    4 年前
  • npm 包 convert-string 使用教程

    简介 convert-string 是一款可以将字符串转换为指定格式的 npm 包。使用它可以方便地进行字符串的格式转换操作。 安装 使用 npm 安装 convert-string： --- ---...

    4 年前
  • npm包 @nodefony/http-bundle 使用教程

    介绍 在前端开发中，我们经常需要处理 HTTP 请求和响应，@nodefony/http-bundle 是 Node.js 中的一个 HTTP 工具包，用于创建和处理 HTTP 请求和响应。

    4 年前
  • npm包@nodefony/mail-bundle使用教程

    前言 对于Web开发，邮件是不可或缺的一个组成部分。@nodefony/mail-bundle是一个用于Node.js的NPM包，它提供了一种快速简便的处理SMTP邮件的方法。

    4 年前
  • npm 包 @nodefony/mongo-bundle 使用教程

    前言 @nodefony/mongo-bundle 是一个 Node.js 的 MongoDB 的 ORM 库，它提供了许多方便的功能，例如表结构的定义和查询，数据导出、导入等等。

    4 年前
  • npm 包 @nodefony/mongoose-bundle 使用教程

    Mongoose 是一个基于 Node.js 平台的 MongoDB 对象模型工具，它是一个非常流行的 JavaScript 模型库，用于管理与 MongoDB 数据库相关的对象和关系。

    4 年前
  • npm 包 babel-plugin-transform-mangle-names 使用教程

    前言 在前端开发中，经常需要使用 ES6 或者更高版本的语法，并将其转换成能够被现有浏览器所识别的 ES5 语法。在这个过程中，我们会使用一系列的工具来帮助我们完成这个转换。

    4 年前
  • npm 包 babel-preset-escompress 使用教程

    前言 在前端开发中，我们经常会遇到 ES6 语法的编写和转换工作，这时候就需要使用到 babel 转换器。babel-preset-escompress 是一个非常强大的预设，它可以快速地将 ES6 ...

    4 年前
  • npm 包 escompress 使用教程

    在前端开发中，压缩和混淆 JavaScript 代码是非常重要的一环。而 npm 包 escompress 可以帮助我们实现这一目标。本文将详细介绍 escompress 的使用方法，包括安装、配置以...

    4 年前
  • npm 包 @nodefony/realtime-bundle 使用教程

    前言 随着互联网技术的发展，实时通信已经成为了很多应用中必备的功能，而实时通信需要用到 WebSocket 这个协议。Node.js 是一门用于构建高效可扩展的 Web 应用程序的编程语言，因此也成为...

    4 年前
  • npm 包 @nodefony/redis-bundle 使用教程

    在现代 Web 开发中，缓存是一项非常重要的技术。缓存可以显著提高应用程序的性能，减少资源消耗，提高用户体验。Redis 是一种流行的缓存服务器，它提供了高效的内存存储和快速的数据检索能力。

    4 年前
  • npm 包 passport-github2 使用教程

    介绍 passport-github2 是一个用于 Node.js 的 Passport 身份验证库的策略。可以让你使用 Github 账户进行登录、注册等操作。 本教程将详细介绍使用 passpor...

    4 年前

相关推荐

    暂无文章