rehype-prism

PrismでHTML内のコードブロックを構文ハイライトするrehypeプラグインです。ドキュメントページの生成で使われ、Mapboxのドキュメントチームでは保守終了しています。

Xで共有ライセンス: MIT

概要

rehype-prism は、refractorライブラリ経由のPrismでHTML内のコードブロックをハイライトするrehypeプラグインです。preとcode要素を対象にし、code要素のlanguageクラスから言語を判断します。rehypeで直接使うことも、Markdownを変換するunifiedのパイプラインで使うこともできます。Mapboxのドキュメントチームでは使用と保守を終了しています。

主な特長

  • refractor経由のPrismでpreとcodeをハイライト
  • code要素の言語クラスから言語を判定
  • ignoreMissingで未知の言語を無視しエラーを回避
  • aliasオプションで言語の別名を登録

こんな人・用途に

rehypeでコードのハイライトが必要なNodeベースのドキュメント生成向けです。2024年4月から保守されておらず、ブラウザ用にはより軽い方法が案内されています。

アップストリーム
mapbox/rehype-prism
GitHubのフォーク
Guo-astro/rehype-prism
アップストリームのスター数
173
カテゴリ
開発者ツールとインフラ
言語
JavaScript
ライセンス
MIT
フォーク日
2020-11-01
同期状態
同期済み最終同期 2026-10-10

同じカテゴリ: 開発者ツールとインフラ