Repolode
markedjs

markedjs/marked

一个快速的 JavaScript Markdown 解析与编译库,可在浏览器、Node.js 和命令行中使用。

Star
37,253
Fork
3,784
未关闭 Issue
33
最近提交
22小时前

这是什么?

Marked 是一个用 TypeScript 编写的 Markdown 解析与编译库,可以把 Markdown 文本转换为 HTML。它体积小巧,实现了所支持的 Markdown 方言和规范中的全部功能,并且不做缓存,也不会长时间阻塞。

它有三种使用方式:在 Node.js 中作为 npm 包引入,通过 CDN 脚本或 ES 模块在浏览器中直接使用,或者通过命令行工具把文件或标准输入转换为 HTML。库还支持自定义扩展,可接入其解析流程。

需要注意的是,Marked 不会对输出的 HTML 做清理。插入页面前,应先用 DOMPurify 等消毒库处理输出内容,以防止 XSS 攻击。

核心功能

  • 01将 Markdown 解析并编译为 HTML。
  • 02实现所支持的 Markdown 方言与规范的全部功能。
  • 03支持通过自定义扩展修改解析行为。
  • 04可在浏览器、Node.js 服务端和命令行中运行。
  • 05体积小巧,不包含缓存层。

适用场景

  • 在网页中渲染博客文章、文档等 Markdown 内容。
  • 在 Shell 脚本或构建流程中把 Markdown 文件转换为 HTML。
  • 为 Node.js 后端或静态站点生成器添加 Markdown 渲染能力。

快速上手

  1. 1

    使用 npm 全局安装 marked 命令行工具

    npm install -g marked
  2. 2

    通过命令行将标准输入的 Markdown 转换为 HTML

    marked -o hello.html

使用前须知

  • 不会对输出的 HTML 进行清理,处理不可信输入时需要额外使用 DOMPurify 等清理库。
  • 仅支持当前及 LTS 版本的 Node.js。

标签

常见问题

marked 是什么?
一个快速的 JavaScript Markdown 解析与编译库,可在浏览器、Node.js 和命令行中使用。 Marked 是一个用 TypeScript 编写的 Markdown 解析与编译库,可以把 Markdown 文本转换为 HTML。它体积小巧,实现了所支持的 Markdown 方言和规范中的全部功能,并且不做缓存,也不会长时间阻塞。
marked 可以免费使用吗?用的什么许可证?
marked 以 Other 许可证开源。用于商业产品前,请先确认许可证条款。
marked 还在维护吗?
活跃维护中。marked 最近一次提交是在 2026年10月21日。
marked 适合用来做什么?
在网页中渲染博客文章、文档等 Markdown 内容。 在 Shell 脚本或构建流程中把 Markdown 文件转换为 HTML。 为 Node.js 后端或静态站点生成器添加 Markdown 渲染能力。
marked 怎么安装和运行?
使用 npm 全局安装 marked 命令行工具: npm install -g marked 通过命令行将标准输入的 Markdown 转换为 HTML: marked -o hello.html
在哪里获取 marked?
源代码和安装说明在 GitHub 上:https://github.com/markedjs/marked

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目