highlightjs.inc.php

名称シンタックスハイライトプラグイン
ファイルhighlightjs.inc.php
バージョン1.00
対象サーバーPukiWiki 1.5.3 / PHP 7.4 / UTF-8
対象ブラウザーFirefox, Chrome, Safari, Edge 各最新版
ライセンスGPLv3

highlight.jsにより整形済みテキストをシンタックスハイライト(文法強調)表示するPukiWiki用プラグイン。

対象とする整形済みテキストの直前に挿入するだけの簡単仕様です。

インストール

highlightjs.inc.php
3.3KB | 2020-10-10

highlightjs.inc.phpPukiWikipluginディレクトリに配置してください。

使い方

次を整形済みテキストの直前に記述する。

#highlightjs([language])
  • language … 言語名。省略すると自動判定。対応言語はhighlight.js公式サイトを参照

使用例

#highlightjs
 function hoge($v) {
     static $fuga = 'value:';
     echo $fuga . $v;
 }

出力

function hoge($v) {
    static $fuga = 'value:';
    echo $fuga . $v;
}

設定

コード内の下記の定数で動作を制御することができます。

定数名既定値意味
PLUGIN_HIGHLIGHTJS_SCRIPT_URLURL文字列'//cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.2.1/build/highlight.min.js'highlight.jsスクリプトのURL
PLUGIN_HIGHLIGHTJS_CSS_URLURL文字列'//cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.2.1/build/styles/default.min.css'highlight.jsCSSURL。空なら内蔵スタイルを適用

highlight.jsが公式にホスティングしている最新版スクリプトのURLと、それに対応するお好みのスタイルCSSURLを指定してください。もしくは、ダウンロードして自サーバーに配置したファイルのURLを指定してください。

default.ini.phpへの設定

本プラグインの定数設定(ファイル内の下記のような行)は、PukiWikiルートディレクトリにある標準設定ファイルdefault.ini.phpにも記述することができます。本プラグインの定数設定行をdefault.ini.phpの末尾にそのままコピーしてください。default.ini.php側の設定値が優先されます。

/////////////////////////////////////////////////
// ○○プラグイン設定(○○.inc.php)
if (!defined('PLUGIN_○○_×××)) define('PLUGIN_○○_×××', △);

設定をdefault.ini.phpに記述することで、プラグインをアップデート(ファイル上書き)するたびに値を書き直す必要がなくなります。また、設定がdefault.ini.phpに集中することで、運用中の設定管理も楽になります。

凡例

プラグインの引数は下記の書式で表現しています。

  • [] … 省略でき必要に応じて記述します
  • | … |で区切られた項目のうち1つを記述します
  • {} … 中カッコ内の引数は任意の順序で記述できます