npm 包 primer-markdown 使用教程

介绍

在前端开发中，我们经常需要解析和渲染 Markdown 文本。prmisder-markdown 是一个基于 markdown-it 开发的 npm 包，它提供了丰富的 Markdown 扩展和样式。本文将介绍如何使用 primer-markdown 来解析和渲染 Markdown 文本。

安装

通过 npm 安装：

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

使用

加载模块

在使用 primer-markdown 之前，我们需要先加载模块：

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

初始化

然后，我们需要创建一个 PrimerMarkdown 的实例：

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

配置

如果需要配置 primer-markdown，我们可以传入一个配置对象：

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

以上配置会打开 markdown-it 自带的一些扩展功能。

渲染

使用 render 方法可以将 Markdown 文本渲染成 HTML：

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

渲染选项

render 方法还可以接收一个用于渲染的选项对象：

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

以上选项会打开 GitHub Flavored Markdown 的一些扩展功能。

插件

primer-markdown 还提供了一些插件，可以扩展 Markdown 的语法和样式。

emoji 插件

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

task lists 插件

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

代码块

primer-markdown 还提供了一些样式来美化代码块。使用以下的样式类可以实现不同的效果：

  • .highlight: 高亮样式；
  • .line-numbers: 显示行号；
  • .diff-highlight: 显示差异。
----- ---------------- ----------------------------------------------------------------------------------------
------- -------------------------------------------------------------------------------------------
-----------------------------------------------
---- ---------------- ------------------- ----------------------------
----- -------- - ------- ------------------
----------------------
-------------

示例代码

以下是一个完整的示例代码：

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

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

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

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

-- -----

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

总结

到这里，我们已经学习了 primer-markdown 的使用方法和一些扩展功能，包括插件和代码块。希望这篇文章对你有所帮助。

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

阅读全文

猜你喜欢

  • 使用 eslint-config-mlmorg 包进行前端代码审查

    当我们大规模开发前端应用时，代码质量控制就成为了一个必须要解决的问题。ESLint 是一个非常优秀的 JavaScript 语法检查工具，它能够在开发过程中帮助我们通过定义一系列规则来自动化检查 Ja...

    4 年前
  • npm 包 @turf/clean-coords 使用教程

    前言 在进行前端地图开发时，我们经常需要使用一些地理信息处理工具库来完成我们的需求。其中，@turf/clean-coords 是一个非常优秀的地理信息处理工具库，它可以帮助我们清理不同精度的坐标点，...

    4 年前
  • npm 包 @turf/clusters 使用教程

    随着 Web 技术的快速发展，前端开发日益复杂，需要应对越来越多的数据和需求。而在处理地理信息时，统计空间数据和聚类分析是常用技术。npm 上的 @turf/clusters 包提供了丰富的地图聚类分...

    4 年前
  • npm 包 @turf/clusters-dbscan 使用教程

    介绍 @turf/clusters-dbscan 是一个由 Turf.js 开发的 npm 包，用于在地图上进行点聚类。该包使用 DBSCAN（Density-Based Spatial Cluste...

    4 年前
  • npm 包 skmeans 使用教程

    前端的数据处理工具越来越多样化，其中 k-means 算法在机器学习和数据科学领域中被广泛使用。在前端开发领域中，我们可以使用 skmeans 包来实现 k-means 算法，来对数据进行聚类分析。

    4 年前
  • npm 包 concaveman 使用教程

    前言 前端开发中，常常需要进行各种图形处理。而凸壳算法是其中一个常用的算法，也是很多图形处理库中的重要部分。Node.js 环境下有一个很好用的凸壳算法 npm 包，就是 concaveman。

    4 年前
  • npm 包 @turf/clusters-kmeans 使用教程

    前言 @turf/clusters-kmeans 是一款基于 Javascript 的工具库，用于实现 K-Means 聚类算法。K-Means 算法是一种经典的聚类算法，能够将一些数据点，按照它们之...

    4 年前
  • npm 包 @turf/collect 使用教程

    前言 在前端开发中，有时候需要将一些地理空间数据进行分析和处理，如计算距离、面积、交叉等等。其中，一个优秀的地理空间分析工具库就是 Turf.js，它提供了很多常用的空间计算方法。

    4 年前
  • npm 包 @types/console-log-level 使用教程

    简介 在编写 JavaScript 或 TypeScript 的过程中，调试信息的输出非常重要，而适当的日志等级也是关键之一。console-log-level 是一个功能强大的日志记录库，它支持多种...

    4 年前
  • npm 包 @turf/combine 使用教程

    npm 是一个 JavaScript 的软件包管理器，它能够方便地管理各种 JavaScript 库和工具的安装、升级和依赖。而 @turf/combine 是 npm 上的一个 GeoJSON 处理...

    4 年前
  • npm 包 passwordless-tokenstore 使用教程

    在 Web 开发中，常常需要处理用户登录认证相关的功能。而身份认证的过程中，使用临时 Token 的模式是非常常见的方式，这也就意味着需要找到一个高效简单的 Token 管理库。

    4 年前
  • npm 包 @turf/difference 使用教程

    前言 在前端开发过程中，我们经常需要对地理信息进行处理，例如计算两个几何对象的差异。而 @turf/difference 是一个很有用的 npm 包，它可以帮助我们实现这种计算。

    4 年前
  • npm 包 passwordless-tokenstore-test 使用教程

    介绍 在前端开发中，我们通常会使用一些 npm 包来帮助我们完成一些重复性的工作或增加一些额外的功能。passwordless-tokenstore-test 就是一个非常实用的 npm 包，它可以帮...

    4 年前
  • npm 包 get-closest 使用教程

    什么是 get-closest get-closest 是一个基于 JavaScript 的 npm 包，专门用来查找元素的最近父级。它可以查询最近的已命名父级，也可以根据元素类型查询。

    4 年前
  • npm 包 @turf/dissolve 使用教程

    简介 Turf.js 是一个用于地理空间数据操作的 JavaScript 库，其中 @turf/dissolve 是其提供的一种针对面 geometry 类型的聚合方法，可以将多个面要素简化成一个面要...

    4 年前
  • npm 包 gulp-angular-filesort 使用教程

    在前端开发过程中，我们常常需要对 AngularJS 项目进行打包和优化。而针对 AngularJS 项目，一个常见的问题就是依赖文件的顺序。如果依赖文件的顺序不正确，很可能会导致程序出现异常或错误。

    4 年前
  • npm 包 @turf/ellipse 使用教程

    前言 在使用地理信息系统（GIS）进行地图绘制和数据分析时，经常需要绘制椭圆形或确定椭圆形的一些参数（如长半轴，扁率等）。而 @turf/ellipse 是一个非常便捷的 npm 包，可以用来生成指定...

    4 年前
  • npm 包 @turf/envelope 使用教程

    背景介绍 在前端 GIS 开发中，常常需要对地图上的要素进行一些测量计算。而在实际的开发过程中，我们有时需要对多个要素的边界进行计算。这时候，一个 npm 包 @turf/envelope 就可以发挥...

    4 年前
  • npm包@turf/explode使用教程

    简介 在前端开发中，经常需要对地理数据进行一些处理，例如将多边形分割成多个三角形、计算多边形中心点等。这时，使用一些专门的地理数据处理库便可事半功倍。@turf/explode就是这样一款npm包，它...

    4 年前
  • npm 包 @turf/flip 使用教程

    前言 Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，可以让 JavaScript 在服务器端运行。而 npm 是随同 Node.js 一起安装的包管理工具，是...

    4 年前

相关推荐

    暂无文章