ライブラリ / SDK
highlightjs/highlight.js avatar
highlightjs/highlight.js

Highlight.jsの自動判定をコード表示に使う条件

言語の自動検出と依存関係のない JavaScript 構文ハイライター。

スター 24,992フォーク 3,755JavaScriptBSD-3-Clause

ひと目でわかる

これは何?
highlightjs/highlight.js はブラウザとNode.jsの双方で動くJavaScript製シンタックスハイライターです。preとcode、highlightAll、highlightElement、言語指定、180超の言語、CDNとnpmの導入をREADMEに沿って整理します。
誰に向いている?
Highlight.jsは、WebページやNode.jsでコードブロックを読みやすく表示したい開発者に向きます。ソースコードを解析・実行したり、全言語の判定精度を無条件に保証したりする道具ではありません。
商用利用できる?
できます。BSD-3-Clause は寛容なライセンスで、著作権表示とライセンス表示を残せば、使用・改変・販売が可能です。
今もメンテナンスされている?
されています。最後のコミットは 9 日前です。
何の言語で書かれている?
主に JavaScript です(GitHub の言語統計による)。

回答はプロジェクトの GitHub データ(最終同期:2026年9月15日)と当サイトの分析に基づくもので、法的助言ではありません。

オープンソース詳細解説

pre codeを入口にする理由

READMEはブラウザでの最小構成として、テーマのCSS、highlight.min.js、hljs.highlightAll()を読み込む例を示しています。highlightAllはpre code内を探して、言語を自動判定します。明示したい場合はclass=language-htmlのように指定します。HTMLを装飾するライブラリであり、コードを実行する機能の説明ではありません。

最初の試験では、同じコードを自動判定とlanguageクラス指定で表示します。誤判定が起きる入力を把握し、社内ページでは自動判定に任せる範囲を狭める判断ができます。CSSテーマのパス、preの有無、生成されたHTMLのエスケープを確認し、見た目だけで成功としないことが大切です。(対象リポジトリ: highlightjs/highlight.js)

plaintextとnohighlightの使い分け

READMEには実際には色付けしないままHighlight.jsのスタイルを適用する方法としてlanguage-plaintextがあり、処理自体を飛ばす場合はnohighlightクラスを使うとあります。ログ、設定例、入力データをすべて自動解析する必要はありません。

この二つは目的が違います。見た目を揃えるブロックにはplaintext、ライブラリに触れさせたくないブロックにはnohighlightを使います。ページ生成側がclassを上書きしていないか、コード中の文字列がHTMLとして解釈されていないかを確認してください。READMEはセキュリティ審査の代替ではないため、外部入力をそのまま表示する設計は別に検討します。

Node.jsでのAPI選択

Node.jsの例ではrequire('highlight.js')で全言語を読み込み、highlightAutoのvalueを使います。人気の言語だけならhighlight.js/lib/commonを読み込め、特定言語ならhighlightのlanguageオプションを渡します。highlightとhighlightAutoの結果オブジェクトや詳細はAPI docsへ分離されています。

サーバー側でHTMLを生成する場合、全言語読み込みとcommonのサイズや初期化時間を同じとみなせません。実際に出力する言語一覧を決め、明示指定と自動判定のどちらを採るかを入力単位で固定します。ES6 import、CommonJS、ブラウザモジュールの構文差も、package設定と一緒に確認対象にします。

カスタム要素と改行の罠

READMEはhighlightElementとconfigureを挙げ、pre codeを使う構成を推奨しています。div.codeのような独自要素でもhighlightElementは呼べますが、preのように改行を保持する要素がない場合はCSSが必要です。div.codeにwhite-space: preを指定する例もあります。

この注意は、ハイライト処理とレイアウト処理が別であることを示します。既存のMarkdown rendererがpreをdivへ変換するなら、変換後のDOMで改行と横スクロールを確認します。DOMContentLoaded後に各pre codeへhighlightElementを呼ぶ例もあるため、動的挿入のブロックを別のタイミングで処理する必要があるかは、アプリの生成経路で決めます。

180超の言語とVersion 11

READMEはcore libraryで180超の言語をサポートし、third-party language definitionsもあると説明しています。ただし、数が多いことは自動判定がすべての入力で正しいことを意味しません。SUPPORTED_LANGUAGES.mdが一覧の確認先です。

Version 11への更新ではbreaking changesがあり得るため、VERSION_11_UPGRADE.mdを読むよう案内されています。古い版の長期サポートはSECURITY.mdが入口です。ライセンスはBSD-3-Clauseと素材に記録されています。採用前は使用言語、読み込み方法、11系移行差分、生成HTMLを固定し、CDN版とnpm版を同じ版番号として扱えるかを確認します。(対象リポジトリ: highlightjs/highlight.js)

Highlight.jsを組み込むときは、言語の自動判定を便利な既定値としてではなく、入力ごとの選択として扱います。pre codeにhighlightAllを呼ぶページ、languageクラスを指定するページ、Node.jsでhighlightまたはhighlightAutoを呼ぶページを分けます。plaintextは装飾だけ、nohighlightは処理を避ける指定です。divを使う場合はwhite-space: preと改行の保持を確認します。全言語のrequireとlib/commonの差、ES6 importの解決、CDNの版を記録してください。11.12.0を基準にVERSION_11_UPGRADE.mdとSECURITY.mdを読み、生成HTMLを外部入力へ適用する場合のエスケープもアプリ側で点検します。

Highlight.jsの自動判定をコード表示に使う条件についても、この確認単位を崩さないことが必要です。Highlight.jsの自動判定をコード表示に使う条件

この判断で見るべきなのは、READMEの宣伝文句ではなく、対象版で再現できる境界です。導入前にプロジェクト名、参照タグ、設定ファイル、入力、出力、失敗時のログを一組にして保存します。公式READMEに書かれていない既定値は、記事の事実として補いません。小さな入力で正常系を通した後、権限不足、空の入力、再起動、版の不一致を順に試します。結果が仕様と一致しない場合は、採用を急がず、その差をissueや公式ドキュメントの該当箇所と照合します。ライセンスは利用形態を確認する入口であり、認証や個人情報の扱いを判断する資料ではありません。更新時はリリースタグと変更点を記録し、前の組み合わせへ戻せる状態を残します。(対象リポジトリ: highlightjs/highlight.js)

記事で扱った範囲には、READMEが直接説明した事実と、まだ資料に現れていない条件があります。前者はコマンド、ファイル名、タグ、API、ライセンスとして再確認できます。後者は性能、可用性、認証、保存、復旧などの運用条件です。両者を同じ確度で書かず、対象リポジトリの版を変えたときは、同じ入力と同じ設定で結果が変わらないかを記録します。採用を決める単位は製品名ではなく、実際に使う機能と責任範囲です。

編集部の結論

Highlight.jsは、WebページやNode.jsでコードブロックを読みやすく表示したい開発者に向きます。ソースコードを解析・実行したり、全言語の判定精度を無条件に保証したりする道具ではありません。最初にhighlightAllとlanguageクラスを同じサンプルで比較し、使用言語だけを読み込む構成とVersion 11の移行文書を確認することが、採用前の具体的な検証になります。

公式情報源

  1. Official documentation
  2. Official README
  3. Project repository
  4. Release notes
コミュニティノート

コミュニティノート