npm 包 markdown-utils 使用教程

介绍

markdown-utils 是一个基于 Node.js 的 npm 包，用于处理 Markdown 文本的常见需求，如提取标题、生成目录等。该包不仅可以在 Node.js 环境中使用，也可以在浏览器端使用，十分方便。

安装

通过 npm 安装：

npm install markdown-utils

使用

提取标题

extractHeadings 函数可以用于从 Markdown 文本中提取所有标题，返回一个数组，包含所有标题。示例代码：

const { extractHeadings } = require('markdown-utils');

const text = '# 标题1\n文本内容\n## 标题2\n文本内容';
const headings = extractHeadings(text);
console.log(headings); // ['标题1', '标题2']

生成目录

createTableOfContents 函数可以用于生成 Markdown 文本的目录，支持指定最小级别和最大级别，以及指定链接前缀。示例代码：

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

----- ---- - -- ------------- -----------
----- --- - --------------------------- -
  --------- --
  --------- --
  ----------- ----
---
----------------- -- -- -------------- ------------
展开代码

渲染 Markdown

renderMarkdown 函数可以用于将 Markdown 文本渲染为 HTML，支持指定代码高亮样式、目录生成等选项。示例代码：

const { renderMarkdown } = require('markdown-utils');

const text = '# 标题1\n文本内容\n## 标题2\n文本内容';
const html = renderMarkdown(text, {
  highlightStyle: 'github',
  toc: true,
});
console.log(html);

以上是 markdown-utils 的常用功能介绍，更多详细信息请查看 官方文档。

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