npm 包 pm-loader 使用教程

简介

pm-loader 是一个基于 webpack 的加载器,可以将 markdown 文件转换为 html 并插入到页面中。它可以用于编写博客、文档等前端类网站的内容。

安装

在项目根目录下,执行以下命令进行安装:

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

配置 webpack

在 webpack.config.js 中添加以下代码:

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

使用

在需要添加 markdown 内容的地方,直接引入即可:

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

其中,content.md 是存放 markdown 内容的文件。

pm-loader 会将 markdown 文件转换为一个 html 字符串,并将其导出为 mdContent 变量,可以在 Vue/React 组件中使用。

注:如果需要在 html 中使用图片,需要将图片文件也放在 webpack 的处理范围内。

配置

pm-loader 还提供了一些配置项,如下:

escapeHtml

  • 类型:Boolean
  • 默认值:false

设为 true 后,将在转换 markdown 内容时,对 html 实体进行转义。

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

anchor

  • 类型:Boolean
  • 默认值:true

设为 true 后,会为标题自动添加锚点链接。

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

toc

  • 类型:Boolean|Object
  • 默认值:false

设为 true 后,会为内容生成目录。也可以配置 toc 来自定义目录的样式和分级。

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

highlight

  • 类型:Function
  • 默认值:hljs.highlightAuto

用于代码高亮,可以自定义一个 highlight 函数将代码块高亮。

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

示例代码

下面是一个示例,将一个 markdown 文件转换为 html 并使用 Vue 展示:

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

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

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

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

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

总结

通过 pm-loader,我们可以直接使用 markdown 编写前端网站内容。除了基础功能,它还提供了丰富的配置项,可以灵活地定制转换的结果。在编写博客、文档等内容时,可以大大提升生产效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005607881e8991b448dea4a


猜你喜欢

  • npm 包 octokit-fixtures 使用教程

    前言 在前端开发过程中,我们常常需要进行接口测试。而针对于接口测试,我们需要一个数据模拟器来进行测试。本文介绍了一个npm包——octokit-fixtures,它可以帮助我们模拟GitHub API...

    3 年前
  • NPM包Babel-Plugin-Log-Consolations使用教程

    随着浏览器技术的不断升级和发展,前端开发的技术栈也越来越丰富和复杂。为了提高开发效率和代码质量,很多开发者会选择使用一些方便的工具来辅助开发。其中一个重要的工具就是Babel,它可以将ES6+的语法转...

    3 年前
  • npm 包 commit-msg-must-use-emoji 使用教程

    作为前端开发者,我们不仅需要关注代码质量和规范,还需要注重 git commit message 的规范,今天我们来介绍一款 npm 包 commit-msg-must-use-emoji,它可以校验...

    3 年前
  • npm 包 alfred-melon-youtube 使用教程

    在前端开发中,我们经常需要从网络上获取数据来供我们的应用程序使用。YouTube 是视频分享最广泛使用的网站之一,因此,学习如何使用 npm 包 alfred-melon-youtube 可以帮助我们...

    3 年前
  • npm 包 cli-dict 使用教程

    最近在前端开发中,一些工具的使用已经不仅仅是辅助工作,更是变成必须的一部分。命令行工具是我们开发中不可或缺的一种工具,灵活易于扩展。而 cli-dict 是一个可以帮助我们在命令行下快速查询单词的 n...

    3 年前
  • npm 包 eliseumds-react-jsonschema-form 使用教程

    在前端开发过程中,我们常常需要实现一个复杂的表单界面。然而,手写表单界面的代码量比较大,而且容易出错。为了提高开发效率,我们可以使用现有的 npm 包,比如 eliseumds-react-jsons...

    3 年前
  • npm 包 ngts-modal 使用教程

    什么是 npm 包? npm(全称:Node Package Manager)是 Node.js 中的一个包管理工具,通过使用 npm 可以安装、升级和卸载 Node.js 模块和包,方便开发者在开发...

    3 年前
  • npm 包 express-flash-2 使用教程

    简介 express-flash-2 是一个基于 Node.js 平台的 Web 框架 Express.js 的中间件之一。它可以让我们在网站页面间传递信息,比如成功或失败的消息提示,这些消息只会出现...

    3 年前
  • npm 包 node-verge 使用教程

    在前端开发中,我们常常需要判断设备类型以及浏览器类型等信息。node-verge 是一个方便实用的 npm 包,可以帮助我们获取这些信息。本文将详细介绍 node-verge 的使用方法。

    3 年前
  • npm 包 node_npm_practice 使用教程

    介绍 npm 是 Node.js 的包管理器,用于管理 Node.js 的依赖包。而 node_npm_practice 是一个基于 npm 的前端技术包,可以帮助前端工程师提高开发效率。

    3 年前
  • npm 包 phaser-plugin-scene-graph 使用教程

    前言 phaser-plugin-scene-graph 是一个基于 Phaser 框架的 npm 包,用于管理场景的层级结构。该插件能够大大简化前端项目中场景层级管理的复杂度。

    3 年前
  • npm 包 react-pressure 使用教程

    React Pressure 是一个 React 库,用于监测用户在移动设备上的屏幕压力和触控,使用该库可以为用户提供更加自然和流畅的交互体验。本篇文章将为你介绍如何使用 React Pressure...

    3 年前
  • npm 包 redux-sequential-async-actions 使用教程

    如果你是个前端开发者,你一定知道 Redux 是一个可预测、可维护的状态管理工具。但是,当你需要处理的复杂场景变得越来越多时,Redux 可能会对异步操作的处理带来一些困难。

    3 年前
  • npm包rn-webview-logger使用教程

    在React Native开发中,Webview组件是非常常用的控件。但是,由于其受原生WebView控件的限制,难以像调试时输出console.log一样调试Webview内部的数据。

    3 年前
  • npm 包 rn-webview-messaging 使用教程

    本文将介绍如何使用 npm 包 rn-webview-messaging 实现 React Native 和 WebView 之间的双向通信。 什么是 rn-webview-messaging rn-...

    3 年前
  • npm 包 @krvikash35/ffi 使用教程

    在前端开发中,我们常常有需要让 JavaScript 与其他语言进行交互的情况,这时候我们往往需要使用 ffi 技术(Foreign Function Interface)来实现。

    3 年前
  • npm 包 json-pipe-protocol 使用教程

    什么是 json-pipe-protocol json-pipe-protocol 是一个能够将 JSON 对象转换为行为 “管道流” (pipe stream) 的 npm 包。

    3 年前
  • npm 包 @krvikash35/ref-struct 使用教程

    介绍 在前端开发过程中,经常需要处理 JavaScript 中的对象和结构体数据。为了帮助开发者更高效地处理这些复杂的数据结构,npm 社区中推出了一个名为 ref-struct 的 npm 包。

    3 年前
  • npm 包 kodaman 使用教程

    1. 什么是 kodaman kodaman 是一个基于 Node.js 的可嵌入式计算机仿真环境,它使用 JavaScript 作为编程语言。kodaman 可以模拟单片机、嵌入式 Linux 等多...

    3 年前
  • npm 包 rocketpants-model 使用教程

    前言 在前端开发中,使用 npm 包是提高效率的必经之路。而 rocketpants-model 就是一个非常实用的 npm 包,可以为我们快速构建 RESTful API,并且提供了很多便捷的功能和...

    3 年前

相关推荐

    暂无文章