npm 包 mkellyclare 使用教程

简介

mkellyclare 是一个npm包，提供一个简单的、易用的解析 markdown 的功能。它没有过多的依赖和复杂的配置，只需要简单的调用即可解析markdown文本。

安装

在终端中运行以下命令进行安装：

npm install mkellyclare --save

使用方法

const mkellyclare = require('mkellyclare');
const markdownText = '# Hello, World!';
const htmlText = mkellyclare(markdownText);
console.log(htmlText); // "<h1>Hello, World!</h1>"

mkellyclare 可以直接从导入的模块中调用，其参数为一个字符串，即需要被解析的markdown文本。解析完成后，mkellyclare 会返回一个新的字符串，即HTML格式的文本。

mkellyclare 也可以接收一个配置对象，该对象包含两个属性:headingIds，和 autolink。

const config = {
  headingIds: true, // 为每个标题自动添加 ID
  autolink: true, // 自动将 url 和 email 转换成 a 标签
}
const htmlText = mkellyclare(markdownText, config);

参数介绍

headingIds

默认情况下，mkellyclare 不会为每个标题自动添加 ID，若开启该选项，则为每个标题自动添加一个ID，对于制作锚链接有帮助。使用方法：

const config = {
  headingIds: true,
}
const htmlText = mkellyclare(markdownText, config);

autolink

默认情况下，mkellyclare 不会将其转化为 html 中的 a 标签，而接收到一个名为 autolink 的 bool 值的参数，如果值为 true，则会将其转为链接。使用方法:

const markdownText = 'Visit http://www.example.com or email mailto:example@example.com';
const config = {
  autolink: true,
}
const htmlText = mkellyclare(markdownText, config);

可支持的语法

mkellyclare 支持常见的 Markdown 语法，包括：

标题

# H1
## H2
### H3
#### H4
##### H5
###### H6

引用

> 这是一段引用的文字

粗体和斜体

**粗体**
__粗体__
*斜体*
_斜体_

链接

[显示文字](链接地址)

列表

• 无序列表

- 列表项

• 有序列表

1. 列表项

代码块

`代码内容`

代码段

​```js(指定语言)
代码内容
​```

分割线

---

示例代码

以下是一个完整的示例代码，它将 Markdown 转化为 HTML 并插入到文档中：

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

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

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

总结

mkellyclare 是一个非常实用的 npm 包，可以帮助前端开发人员快速的解析Markdown文本，并将其转化为HTML格式。上述内容中我们介绍了mkellyclare 的安装方法，使用方法，以及支持的语法，希望可以为你提供帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055ad581e8991b448d870f