omachizura

仕事メモ、役に立ったスキルをまとめています。


highlight.jsをローカルで実行してハイライトされたファイルを出力

ホームページやブログでプログラムのコードを掲載する際に、以下のようにコードをシンタックスハイライト(色付け)をすることがあると思います。

<canvas id="canvas" width="800px" height="600px" style="border:1px solid #000;background-color: #fffac;" ></canvas>

highlight.jsという便利なライブラリを使っていましたが、ページ表示時間のパフォーマンス向上のため、静的ホームページはgulpなどを使用し、ローカルで予め色づけした状態のhtmlを作成しようと思いました。(これからはamp html対応に向けて、JavaScriptはなるべく使用しない方針で作成したほうがいいかもしれません)

node.js

最初は以下のようにgulpのプラグインとして実行すると、色付けされた(色付けのclassを付与された)htmlを出力するような処理を実装しようとしました。

gulp.task('highlight', function(){
  return gulp.src('対象のファイル')
    .pipe(highlightjs())
    .pipe(gulp.dest('出力先'));
});

しかし、調べてみてもいいプラグインが見つからなかったので、別の方法を探すことにしました。

node.jsのライブラリが用意されていますので、これを使用しました。

$ npm install highlight.js

そして以下のようなfunctionを実行し、色付けclassが付与されたファイルを出力するようにしました。(gulpのpipeに組み込めるようにしたかったのですが、知識不足のためやり方がわかりませんでした...)

追記:pipeに独自のファンクションを組み込む方法がわかりましたので、 gulpのpipeで独自のファンクションを実行する で紹介しています。

var fs = require('fs');
var hljs = require('highlight.js');

function highlight(file, type){
    var data = fs.readFileSync(file); //ファイルの内容を取得
    //highlight(言語パターン, 内容)でクラスを付与したデータを返します
    fs.writeFileSync('出力先', hljs.highlight(type, data.toString()).value);
  }
}

例えば上記のファイルに対してhighlightのファンクションを実行すると、以下のファイルが出力されます。

<span class="hljs-keyword">var</span> fs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'fs'</span>);
<span class="hljs-keyword">var</span> hljs = <span class="hljs-built_in">require</span>(<span class="hljs-string">'highlight.js'</span>);

<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">highlight</span>(<span class="hljs-params">file, type</span>)</span>{
    <span class="hljs-keyword">var</span> data = fs.readFileSync(file); <span class="hljs-comment">//ファイルの内容を取得</span>
    <span class="hljs-comment">//highlight(言語パターン, 内容)でクラスを付与したデータを返します</span>
    fs.writeFileSync(<span class="hljs-string">'出力先'</span>, hljs.highlight(type, data.toString()).value);
  }
}

highlight.jsで色付けされるclassが付与されたhtmlとして出力されています。また、同時に<,>,&などはhtmlでそのまま表示できるようエンコードされます。

出力された内容を以下のような形でclass="hljs"を付与したタグで囲えば、シンタックスハイライト表示できるようになります。

<pre><code class="hljs">
<!-- ここに出力された内容をセット-->
</code></pre>

classが付与されただけなので、以下のようにhighlight.jsで使用しているcssはこれまでどおり参照する必要があります。

<link rel="stylesheet" href="styles/default.css">

これでhighlight.jsに対応していない古いブラウザやJavaScriptがオフの環境でも、シンタックスハイライトをしたコードを表示できるようになりました。また、JavaScriptを実行しないので、画面ロードの時間も少しは短縮されると思います。