Highlight.jsに乗り替えて高速化、重いCrayonを捨てる

2017-03-012020-02-29WordPressカスタマイズ,WordPressプラグイン

本記事はWordPressプラグイン「WP Code Highlight.js」の紹介です。

本記事は「Highlight.js」の紹介です。
現在「Crayon Syntax Highlighter」を使っている方は、乗り替えるだけでかなりの高速化が図れます。

【2020/2/1追記】

残念ながら「WP Code Highlight.js」はセキュリティ上の理由により公開停止となりました。
従って本家の「Highlight.js」の紹介に書き換えました。

激重のCrayon Syntax Highlighter

コード入力に欠かせないSyntaxHighlighterプラグイン。
その代表格と言いうるのが「Crayon Syntax Highlighter 」（通称クレヨン or Crayon）、多くの方が使っているのではないかと思われます。

しかし、

例えば、私の使っているテーマLuxeritasの作者るな様。

有名だけど個人的に使いたくないWordPressプラグインTOP3 | Thought is free

個人的に使いたくないのは、 重くて遅い 動作が怪しい デバッグするとエラーは出ないが、警告がでまく ...

 http://thk.kanzae.net/net/wordpress/t3159/

私の検証記事はこちら。

「SyntaxHighlighter」WordPressプラグインの役割、負荷の比較

本記事の内容は色んなSyntaxHighlighterプラグイン（Crayonなど）のレビュー・負荷比較、結論として推 ...

 https://kimoota.net/syntaxhighlighter/

実はCrayonに限らず、この手のプラグインはどれも重いんですよね。

高速なHighlight.js

そこで評判になったのが、

highlight.js

highlight.js highlight.js Syntax highlighting for the Web #!/bin/bash ###### CONFIG ACCEPTED_HOS ...

 https://highlightjs.org/

説明は割愛しますが間違いなく軽いです。
Crayonなんて比較にもなりません。

Highlight.jsの実装方法

CDNとローカルのどちらでも読み込めます。
私はローカルで読み込んでいます。
自分の環境に合わせて書き換えてください。

デザインを決める

公式サイトへ行きます。

①をクリックすると、CSSデモが切り替わります。
②をクリックすると、さらにたくさんのCSSのデモが見られます。

たくさんある中から使うCSSを選んでください。
気に入ったCSSの名前は控えておいてください。

私が使っているのは「school-book」です。
（日本語翻訳されている場合は「教科書」。

ダウンロード

上記画像の③をクリックします。
開いたページの一番下まで下がります。

ダウンロードをクリックすればファイル入手できます。

CSS

まずは公式のやり方。
次のコードをヘッダーに追加してください（CDN）。
「default」の部分は、使いたいCSSの名前に書き換えます。

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/styles/default.min.css">

私のとっている方法はこちら（ローカル）。

<link rel="stylesheet" href="<?php echo get_stylesheet_directory_uri(); ?>/school-book.css" media="print" onload="this.media='all'">

非同期で読み込ませています。

スクリプト

まずは公式のやり方（CDN）。
次のコードをフッターに追加してください。

<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.1/highlight.min.js"></script>

私のはこちら（ローカル）。

<script src="<?php echo get_stylesheet_directory_uri(); ?>/highlight.min.js"></script>
<script>
jQuery(document).ready(function($) {
	$('pre').each(function(i, block) {
		hljs.highlightBlock(block);
	});
});
</script>

本来は<pre><code>で囲みますが<pre>だけでハイライトされるようになります。
こちらの記事で紹介されていました。

ソースコードをハイライトする軽量ライブラリ、Highlight.jsの使い方

ソースコードをハイライトして見やすく表示するには、Highlight.jsが、軽量でバグもなく、お勧めです。

 https://syncer.jp/how-to-use-highlightjs

syncerのあらゆ様、ありがとうございます。

さらに私の場合、後者のスクリプトもjsファイルにして、Luxeritas（テーマ）の機能でHighlight.jsと結合させて非同期で読み込んでいます。
そうしないとjQueryを非同期で読み込ませた場合、エラーになるので。
（つまり、実際にはフッターに書いていません）

簡単にHighlight.jsを実装するWordPressプラグイン「WP Code Highlight.js」

しかし、そんな方に朗報。
なんとHighlight.jsがWordPressプラグインになっていました。

WP Code Highlight.js – WordPress プラグイン | WordPress.org 日本語

This plugin allow you to use highlight.js to highlight codes on any wordpress page. And you can ...

 https://ja.wordpress.org/plugins/wp-code-highlightjs/

「WP Code Highlight.js」をインストールすることで、コードの変更なしにHighlight.jsの実装が可能となります。
装飾もいっぱい揃っている中から選べます。
これでCrayonにしかないデザインが使いたい方、行数表示が必要な方、ツールバーが必要な方以外にはCrayonが用無しとなります。

WP Code Highlight.js実装方法

インストール

公式でプラグインを検索してインストールします。

まだ1000件ちょいなんですねえ……。
対するCrayon。

50000人超と圧倒的です。

管理画面

数クリックで終わります。

１　CDNを選びます

２　CSSを選びます（省略可能）

いっぱい種類がありますので、ゆっくり後で選んでください。
私は「schoolnote」を使っています。

３　元々使っていたプラグインをチェックする（なければ省略）

主だったプラグインとは互換性があります。
使った場合はチェックをいれてください。

その下の項目はショートコードで入力する場合です。
（通常は<pre><code>～</code></pre>と入力します）

これで終わりです。

今度こそ本当にまとめ

WP Code Highlight.jsが公開停止になったのは心から残念……
でも本家の設置もやってみると簡単だから、ぜひ！