这个项目能做什么
Marked 是一个为速度而设计的 Markdown 解析器和编译器。它是一个低级编译器,解析 Markdown 时不会进行缓存或长时间阻塞,因此适用于对性能敏感的应用程序。该库实现了受支持风格和规范中的所有 Markdown 功能,同时保持轻量级。
主要特点:
- 为速度而生
- 低级编译器,解析 Markdown 时无需缓存或阻塞
- 在实现受支持风格和规范中所有 Markdown 功能的同时保持轻量
- 可通过自定义扩展轻松适应
- 可在浏览器、服务器或命令行界面(CLI)中运行
兼容性:仅支持当前和 LTS 版本的 Node.js。在浏览器中,它面向 Baseline Widely Available 环境。
安装:可以通过 npm 全局安装以用于 CLI,也可以作为包用于浏览器和 Node.js 环境。
用法:该库提供了一个 parse 函数,可将 Markdown 转换为 HTML。它可以在命令行、Node.js 中使用,也可以通过 UMD 或 ESM 模块直接在浏览器中使用。提供了演示页面。
重要警告:Marked 不会对输出的 HTML 进行消毒。用户应对输出的 HTML 应用消毒库(如 DOMPurify、sanitize-html 或 insane),以防止 XSS 攻击。
文档涵盖了选项和可扩展性。该项目采用 MIT 许可证。
评论
0 评分人数达到10人后显示
登录后参与讨论。