Zealでコードドキュメントをオフライン表示する方法【Linux対応】

プログラミングの経験がある方なら、開発作業には大量のドキュメント読解がつきものだと実感しているはずです。場合によっては、コードを書く時間よりもドキュメントや他のコードを読む時間の方が長くなることも珍しくありません。しかも、そのドキュメントの多くはWeb上で提供されているため、目的の情報を探したり、ページが読み込まれるのを待ったりするだけで、貴重な時間が失われがちです。こうした小さな遅延は、特に通信速度が遅い環境ではストレスになり、積み重なれば数分、場合によっては数時間分の生産性低下につながります。さらに、これらの情報にアクセスするには常時インターネット接続が必要ですが、それが常に利用できるとは限りません。

そこで便利なのが、オフラインで動作するドキュメントブラウザ「Zeal」です。Zealを使えば、プログラミング言語やソフトウェアのドキュメントをローカル環境に保存し、素早く効率的に参照できます。Zealは、macOS向けツール「Dash」が提供するドキュメントセット（docset）を利用しており、多数のプログラミング言語・スクリプト言語・ライブラリのドキュメントに加え、Docker、Nginx、WordPress、ElasticSearchといった各種ソフトウェアのドキュメントもカバーしています。

この記事では、LinuxにおけるZealのインストール方法から基本的な使い方、カスタマイズの手順までを詳しく解説します。

Zealのインストール

Zealは多くのLinuxディストリビューションの公式リポジトリで提供されているため、可能であれば各ディストリビューション標準のパッケージマネージャーを使ってインストールするのがおすすめです。

Ubuntu / Linux Mint / Debianの場合

sudo apt install zeal

Arch Linuxの場合

sudo pacman -S zeal

Gentooの場合

sudo emerge app-doc/zeal

Fedoraの場合

sudo dnf install zeal

Zealの基本的な使い方

Zealはアプリケーションメニューやランチャーから起動できるほか、ターミナルでzealコマンドを実行することでも起動できます。

Zealは初期状態ではドキュメントが一切含まれていません。利用可能なdocsetを確認するには、「Tools → Docsets」メニューを開き、「Available」タブを選択します。

必要なdocsetにチェックを入れて「Download」ボタンをクリックするとダウンロードが始まります。取得済みのドキュメントセットは、左上のペインに階層構造で表示され、ツリー形式で自由にナビゲートできます。また、該当する場合は左下のペインに、現在開いているページ内の要素へのショートカット一覧が表示されます。

検索機能の使い方

検索ボックスにキーワードを入力すればすべてのdocsetを横断的に検索できます。特定のdocsetだけを対象にしたい場合は、docset:queryという書式を使用します。たとえば、Pythonのre.match関数を検索したい場合は、python:re.matchと入力します。

注意： この複合検索構文（docset:query）では、docset部分は大文字・小文字が区別されますが、query部分は区別されません。

Zealのカスタマイズ

フォントの変更

Zealの外観は、フォントやフォントサイズを好みに合わせて調整できます。「Edit → Preferences → Content」を開き、デフォルトのフォントファミリーを選択するか、種類ごとに個別のフォントを指定してください。

ダークモード

Zealにはダークモードも用意されています（「Edit → Preferences → Content」内）。ただし、下のスクリーンショットのとおり、ダークモードが適用されるのはドキュメント本文のみで、周囲のGUIには反映されない点に注意しましょう。

ユーザー定義CSSの活用

Zealを日常的に使う予定があるなら、自分好みに調整しておく価値があります。カスタムスタイルシートを使えば、ドキュメントの見た目をより細かくコントロールできます。

まず、テキストエディタで新しいCSSファイルを作成します。

vim ~/.local/share/Zeal/custom.css

次に、適用したいCSSルールを記述します。以下はその一例です。

code {
border-style: dashed;
border-width: 1px;
color: red;
}

その後、「Edit → Preferences → Content → Custom CSS」で作成したCSSファイルを指定します。設定を保存すると、変更はすぐに反映されます。下のスクリーンショットは、上記のCSSを適用した後のZealの様子です。

まとめ

Zealは、ドキュメントを頻繁に参照するプログラマーやシステム管理者にとって非常に心強いツールです。ドキュメントをローカルに保存するため、検索や読み込みにかかる時間を大幅に削減でき、本来の作業に集中できます。さらに、Web上のドキュメントと異なり、ユーザー定義スタイルシートによる柔軟な見た目のカスタマイズにも対応している点も大きな魅力です。オフライン環境でも快適にドキュメントを閲覧したい方は、ぜひZealを試してみてください。