Zealを使用してコードドキュメントをオフラインで表示する方法

コードを書いたことがあるなら、プログラミングにはドキュメントをたくさん読む必要があることにおそらく同意するでしょう。多くの場合、ドキュメントやその他のコードの読み取りに費やされる時間は、実際のコードの記述時間を上回ります。また、そのドキュメントはWebでアクセスされないことが多いため、探している情報を見つけて読み込まれるのを待つために、かなりの時間が無駄になります。これらの小さな遅延は、特に接続が遅い場合にイライラする可能性があり、生産性の損失が数分または数時間かかる可能性があります。さらに、その情報にアクセスするには、常に利用できるとは限らない常時インターネット接続が必要です。

幸い、オフラインのドキュメントブラウザであるZealを使用して、プログラミング言語とソフトウェアのドキュメントをコンピュータに保存し、すばやく効果的にアクセスできます。 Zealは、Dashが提供するドキュメントセット（ドキュメントセット）を使用します。いくつか例を挙げると、多くのプログラミングおよびスクリプト言語とライブラリのドキュメントに加えて、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:queryの構文でクエリまたは特定のドキュメントセットを入力すると、すべてのドキュメントセットを検索できます。 。たとえば、Pythonのre.matchを検索するには 関数の場合、python:re.matchと入力します 。

注： 複合検索構文（つまり、docset:query ）、docset 一部は大文字と小文字が区別され、query 一部は大文字と小文字を区別しません。

熱意のカスタマイズ

フォント

Zealの外観は、フォントとフォントサイズを使用して好みに合わせて構成できます。

これを行うには、[編集]->[設定]->[コンテンツ]に移動し、デフォルトのフォントファミリと各フォントファミリの特定のフォントを選択します。

ダークモード

Zealはダークモードも提供します（[編集]->[設定]->[コンテンツ]）。ただし、次のスクリーンショットに示すように、ドキュメントコンテンツにのみ適用され、周囲のグラフィカルインターフェイスには適用されません。

ユーザー定義のCSS

Zealを定期的に使用する場合は、時間をかけて自分の好みに合わせて調整することをお勧めします。カスタムスタイルシートを使用して、ドキュメントの外観をより細かく制御できます。

テキストエディタを使用して新しいCSSファイルを作成します：

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

目的のCSSルールセットを入力します。例：

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

「編集->設定->コンテンツ->カスタムCSS」ファイルに移動して、新しく作成されたCSSファイルを選択します。設定を保存すると、変更がすぐに表示されます。次のスクリーンショットは、上記のCSSを適用した後のZealを示しています。

結論

Zealは、ドキュメントに頻繁にアクセスする傾向があるプログラマーやシステム管理者にとって優れたツールです。ドキュメントをローカルに保存するため、時間を節約でき、手元の作業に集中できます。さらに、Webドキュメントとは異なり、ドキュメントの外観を細かく制御するためのユーザー定義のスタイルシートをサポートしています。