git-hub_gist_icatch

【WordPress】プラグインやPrism.jsでシンタックスハイライトが動かないときは「Gist」がおすすめ

【WordPress】プラグインやPrism.jsでシンタックスハイライトが動かないときは「Gist」がおすすめ

こんにちは。サラリーマンで育児に奮闘しているおったんです。

この記事では、「Gist」を使ったシンタックスハイライトの方法をご紹介します。

プログラムのコードをシンタックスハイライトさせるには、Gistを使い方法以外に、プラグインやPrism.jsを使った方法もあります。当ブログでは、WordPress上で「The Thor」のテーマ使用していますが、プラグインやPrism.jsのどちらもとうまく表示されませんでした。試しにGistを使ってみたところ、「The Thor」のテーマでもシンタックスハイライトをうまく表示させることができました。

「The Thor」のテーマを使用していなくても、シンタックスハイライトがうまく表示されないとお困りの方に参考になればと思います。

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

プログラムのコードの可読性をあげるためにテキスト中の一部分を異なる色やフォントで表示させることです。

例えば、以下のようなJava言語のコードがあったとします。通常WordPress上でコードを整形済みテキストで表示すると以下のようになります。

public class HelloWorld{
   public static void main(String[] args){
     System.out.println("Hello World!!");
   }
}
man_face2おったん
ちょっと見た目が味気ないかな

これをシンタックスハイライトさせた場合、下のような表示になります。

man_face1おったん
シンタクスハイライトさせるとやはり見栄えが良いですね

The Thorではシンタックスハイライトがうまく表示されない?

当ブログはWordpressを使って運用し、テーマには「The Thor」を使用しています。

以前、The Thorのトップページでアーカイブ記事の抜粋が長くなってしまうことの対応策を記事にしてみました。

あわせて読みたい関連記事

【THE THOR】アーカイブ記事の抜粋が多く表示されてしまった場合の対応策と解決策 こんにちは。サラリーマンで育児に奮闘している「おったん」です。 この記事では、WordPressの「The Thor」のテーマでアーカイブ[…]

The_thor_archive_icatch

その際に用いたCSSのコードをシンタックスハイライトさせようとしたのですが、何故かうまく表示されませんでした。

WordPressの下書き中のプレビューではシンタックスハイライトがうまく表示されるのに、なぜか公開すると通常の灰色の整形済みの表示に切り替わってしまいました。プラグインだけでなく、Prism.jsも試してみたのですが、同様の結果でした。

できればCSSのコードをシンタックスハイライトにしたいなと考え、試行錯誤した結果、Gistを使うと問題なくシンタックスハイライトさせることができたのでその方法を次でご説明します。

Gistでシンタックスハイライトを埋め込むには

Gistはソースコードを1ファイル単位でバージョン管理をし、公開することができるGitHubのサービスの一つです。

アカウントを作成しないと使えないデメリットはあるものの、プラグインによる不具合や自身のサーバー負担がないメリットがあります。

GitHubのアカウントの作成

Gistを使用するためにGitHubのアカウント作成を行います。GitHubのアカウントをお持ちの方は次の項目に進んでください。

  1. GitHubからアカウントの作成を行います。
  2. 任意のユーザー名、Eメールアドレス、パスワードを入力して「サインアップ」のボタンを押します。
  3. 次にプランを選択しますが、Gistは無料プランで使用できるので、「Unlimited public repositories for free.」を選択して「Continue」のボタンを押します。
  4. 登録したメールアドレスにメールが届くので、「Verify email address」のリンクをクリックします。
  5. Githubの画面上部に「Your email was verified.」と表示されGitHubのアカウントが作成されます。
おったん
これでGitHubのアカウントの作成は完了です

Gistの作成とシンタックスハイライトの埋め込み

次にGistの作成とシンタックスハイライトのコードの埋め込みを行います。

  1. GitHubへアクセスし、サインインを行います。
  2. サインイン後に画面右上部のベルの通知マークとアカウントのアイコンのマークの間にある「+」マークをクリックして、「New gist」をクリックします。
  3. ソースコード画面が表示されるのでソースコードを入力します。
    1. 上のテキストボックスでコードの登録名を入力します。
    2. 下のテキストボックスでソースコードを入力します。
    3. 「Create public gist」をクリックして保存します。
  4. Gistの埋め込みコードが生成されるので、「Embeded」というドロップダウンボタンの横のテキストボックスにある”<script src…”という埋め込み用のコードをコピーします。
  5. コピーしたコードをWordPressの投稿の編集画面のテキストエディターに張り付けます。
  6. WordPressの投稿画面のプレビュー画面からGistによるシンタックスハイライトが埋め込まれていることを確認します。
  7. プレビューで問題ないことを確認後、記事を公開します。

これでプラグインやPrism.jsを使わずともソースコードをシンタックスハイライトさせることができます。

man_smile4おったん
この方法で別記事のCSSのコードも無事シンタクスハイライトさせることができました

まとめ

この記事では、プラグインやPrism.jsを使用せずソースコードをシンタックスハイライトさせる方法をご紹介しました。

Gistのシンタックスハイライトってどんな表示か気になる方や、私と同じようにWordPressのプラグインやPrism.jsでシンタックスハイライトを試してもうまく行かなかったという方に参考になればと思います。

git-hub_gist_icatch
最新情報をチェックしよう!