WordPressやウェブサイトでのシンタックスハイライト方法




ブログを書いていて、カスタマイズ方法を載せたり、学んだことのアウトプットを発信するにはソースコードの表記も必要になってきたりしますよね。

ソースコードを綺麗に表示するにはいくつか方法があるので、どんなやり方ができるかのご紹介です。

あまり詳しく言葉の解説をしていないので、プラグインやショートコードなどがわからないようでしたら調べてみてくださいね。

シンタックスハイライトとは

シンタックスハイライトというのは開発で使うエディタなどではよくある機能で、ソースコードを自動でカラーリング、行数表示などして見やすくする表示方法です。

実はブログやウェブサイトでもこのような表示ができるのですが、コードをコピーできたりと色々便利な機能もあったりします。

WordPressのページでソースコードを見やすくする方法

シンタックスハイライトの表示には、WordPress用のプラグインを使うか、JavaScript(以下JS)+CSSが既にまとまっているライブラリを使うかの方法があります。
また、ちょっと別の方法ですが外部サービスを使って埋め込むこともできます。

プラグインはWordPressの機能ですが、JSライブラリや外部サービスを使う方法ではWordPressでもそれ以外のウェブサイトでも使えます。

WordPressプラグインを使う方法

今はSyntaxHighlighter Evolvedが人気のようですね。というわけで使ってみるとこんな感じです。

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>PHP Code Example</title>
</head>
<body>
    <h1>PHP コードサンプル</h1>
 
    <p><?php echo 'Hello World!'; ?></p>
 
    <p>この行はハイライトされました</p>
 
    <div class="foobar">
        This    is  an
        example of  smart
        tabs.
    </div>
 
    <p><a href="http://wordpress.org/">WordPress</a></p>
</body>
</html>

WordPressのプラグインをインストールして有効化し、該当するソースコードをショートコードで囲むだけです。これはかなり簡単に使えますね。

WordPress初心者でも簡単にできると思いますが、デメリットはプラグインのアップデートが必要になったりブログの動作が重くなる可能性がある点と、プラグインの使用を止める際にショートコードの書き換え作業が必要になります。

(これはショートコード系プラグインの宿命ですが、投稿内の文字を簡単に書き換えるプラグインもあるのでそこまで怯えなくても大丈夫です)。

次はプラグインなしでソースコードを埋め込んだり綺麗に見せる方法です。

ライブラリを使う方法

※リンクはダウンロード先です。

現状このあたりが有名っぽいです。また、WordPressプラグインを使うより軽いんじゃないかと思います。

この中でもさらにhighlight.jsが軽いようですが、表示方法や設置方法に違いもあるので詳しくは各リンク先を参照したり調べてみてください。

ライブラリを使うメリットは、導入さえできれば簡単に表示できてカスタマイズや機能性に優れているところです。

WordPressの場合は使うためには自分のブログのヘッダー、フッター部分などにJSやCSSのライブラリを読み込む為のコードを記述する必要があります。

なのでテーマのアップデート時や変更時に注意したり、小テーマを使用するっていう手間があります。このあたりは自分とか担当者がわかってれば大きな問題じゃないと思いますが、出来るだけWordPressのテーマのソースをいじりたくない…っていう方だとちょっとハードルを感じてしまうかもしれないですね。

その他・外部サービスを使う方法

他には埋め込み系のサービスを使う方法もあります。これらもよく見かけます。

Gist

Git Hubの無料サービスで、シンプルにソースコードを埋め込めます。(要Git Hubアカウント)
他にもバージョン管理できたり、ファイルごと残せたりなど機能も色々。ちょっとしたコードを管理したい、という人に向いてますかね。

Codepen

See the Pen h1サンプル by hiroko o (@hirokoo) on CodePen.


Web制作系の記事でよく見かけますが、↑こんな感じです。ブラウザ上でソースコードを表示するだけじゃなく、デモ(Result)も見れたり手軽にシェア出来ちゃう便利サービスです。html、css、JavaScript用なので、言語や用途が合うようであれば便利かと。

外部サービスの良いところは、コードを張り付けるだけで綺麗に表示できて管理もできるところ、特にインストールなど必要ないところですね。またそのサービスの利用者同士のコミュニケーションや、スキルのアピールにもつなげやすいかと思います。

デメリットは、そのサービス上にログインしてコード書いてリンク取得してっていう手間が発生することでしょうか。ブログやメディアの立ち位置によっては、アカウントの管理どうするかも考慮しなくてはいけないかもですね。(企業のメディアなど)

 

以上が、いまある中では綺麗でやりやすいかと思います。ご参考まで!