rehype-prism

使用Prism为HTML中的代码块做语法高亮的rehype插件,用于生成文档页面,Mapbox文档团队已停止维护。

分享到 X许可证: MIT

概述

rehype-prism 是一个 rehype 插件,通过 refractor 库使用 Prism 为 HTML 中的代码块做语法高亮。它处理 pre 和 code 元素,并根据 code 元素上的 language 类名确定语言。可直接配合 rehype 使用,也可放进转换 Markdown 的 unified 流程。Mapbox 文档团队已不再使用和维护它。

主要特点

  • 通过 refractor 用 Prism 高亮 pre 和 code 代码块
  • 根据 code 元素上的语言类名选择语言
  • ignoreMissing 选项可跳过未知语言而不报错
  • alias 选项可注册语言的别名

适用场景

适合需要在 rehype 中做代码高亮的 Node 文档构建。自 2024 年 4 月起不再维护,浏览器端高亮 README 建议使用更轻量的方式。

上游仓库
mapbox/rehype-prism
GitHub 上的 fork
Guo-astro/rehype-prism
上游 Star 数
173
分类
开发者工具与基础设施
编程语言
JavaScript
许可证
MIT
Fork 时间
2020-11-01
同步状态
已同步上次同步 2026-09-29