当前位置：首页 > news >正文

markdown-it

news 2025/10/31 9:05:52

markdown-it是一个使用 JavaScript 编写的、功能强大且高度可配置的 Markdown 解析器,它能够将 Markdown 文本转换为 HTML，并因其出色的性能、扩展性和对 CommonMark 标准的严格遵循而备受青睐

核心特性与安装
markdown-it完全遵循 CommonMark 规范，并支持多种扩展语法（如表格、脚注、任务列表等）
。你可以通过 npm 轻松安装它

npm install markdown-it

// 引入 markdown-it 并创建实例
const MarkdownIt = require('markdown-it');
const md = new MarkdownIt();// 使用 render 方法进行转换
const result = md.render('# Hello, markdown-it!');
console.log(result); // 输出: <h1>Hello, markdown-it!</h1>

配置选项与插件系统
markdown-it的真正强大之处在于其可配置性和插件系统。
常用配置示例：你可以在创建实例时传入一个配置对象来自定义解析行为

const md = new MarkdownIt({html: true,        // 允许在 Markdown 中直接使用 HTML 标签linkify: true,     // 自动将类似 URL 的文本转换为可点击的链接typographer: true  // 启用更优美的排版替换（如引号、破折号）
});

使用插件：通过 .use()方法可以加载插件，以扩展功能。例如，使用 markdown-it-emoji插件来支持表情符号

const md = new MarkdownIt();
const emoji = require('markdown-it-emoji');// 使用插件
md.use(emoji);const result = md.render('Hello :smile:');
console.log(result); // 输出: <p>Hello 😄</p>