markdown-it 入门：快速将 Markdown 转换为 HTML

1. 什么是 markdown-it？

markdown-it 是一个基于 JavaScript 的 Markdown 解析器，可以把 Markdown 文本转换成 HTML。

它遵循 CommonMark 规范，并支持表格、删除线等常见 Markdown 扩展，同时还提供插件机制，可以扩展表情、脚注、目录等功能。

GitHub：

https://github.com/markdown-it/markdown-it

它比较适合用于博客系统、Markdown 编辑器、文档系统等场景。

---

2. 安装 markdown-it

如果项目已经安装 Node.js，可以直接使用 npm 安装：

npm install markdown-it

安装完成之后即可在项目中使用。

---

3. 基本使用

先创建一个 JavaScript 文件：

const MarkdownIt = require('markdown-it')

const md = new MarkdownIt()

const text = `
# Hello markdown-it

这是我的第一段 Markdown 内容。

- HTML
- CSS
- JavaScript
`

const html = md.render(text)

console.log(html)

运行：

node index.js

输出结果大致如下：

<h1>Hello markdown-it</h1>
<p>这是我的第一段 Markdown 内容。</p>

<ul>
  <li>HTML</li>
  <li>CSS</li>
  <li>JavaScript</li>
</ul>

也就是说：

Markdown
    ↓
markdown-it
    ↓
HTML

---

4. 常用配置

创建 MarkdownIt 时还可以传入一些配置：

const md = new MarkdownIt({
  html: false,
  breaks: true,
  linkify: true
})

其中：

• html：是否允许 Markdown 中直接编写 HTML
• breaks：换行是否转换成 <br>
• linkify：是否自动识别 URL

例如：

const md = new MarkdownIt({
  linkify: true
})

console.log(
  md.render('访问 https://github.com')
)

markdown-it 会自动将 URL 识别成链接。

---

5. 为什么使用 markdown-it？

markdown-it 主要有几个特点：

• 性能高：Markdown 解析速度较快
• 规范性好：兼容 CommonMark
• 扩展性强：支持大量插件
• 使用简单：几行代码即可完成 Markdown 转 HTML
• 可自定义：可以修改 Token 和 HTML 渲染规则

---

6. 总结

markdown-it 最核心的功能其实非常简单：

const MarkdownIt = require('markdown-it')

const md = new MarkdownIt()

const html = md.render('# Hello Markdown')

只需要记住：

安装 markdown-it
      ↓
创建 MarkdownIt 实例
      ↓
调用 md.render()
      ↓
得到 HTML

掌握这一步之后，就可以继续学习 Token、插件机制以及自定义渲染规则，这些才是 markdown-it 更强大的地方。