highlightjs/highlight.js:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく highlightjs/highlight.js の導入と確認ガイドです。
プロジェクトの範囲
highlightjs/highlight.js の README はプロジェクトを「JavaScript syntax highlighter with language auto-detection and zero dependencies.」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「Highlight.js」には次の説明があります。Highlight.js is a syntax highlighter written in JavaScript. It works in the browser as well as on the server. It can work with pretty much any markup, doesn't depend on any other frameworks, and has automatic language detection.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Upgrading to Version 11」にある内容から、用途が合うかを先に判断できます。README 没有列出这一项具体能力。。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。README 没有列出这一项具体能力。。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Support for older versions」など複数の箇所に分かれています。確認できる情報は次の通りです。Please see SECURITY.md for long-term support information.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.2/styles/default.min.css"> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.2/highlight.min.js"></script> <!-- and it's easy to individually load additional languages --> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.2/languages/go.min.js"></script> 実行可能なコマンドがない場合は手順を作らず、「Upgrading to Version 11」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「In the Browser」にはThe bare minimum for using highlight.js on a web page is linking to the library along with one of the themes and calling [highlightAll][1]:とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはREADME 没有列出这一项具体能力。ともあります。