Linux macOS

クロスプラットフォームな Docset ドキュメントブラウザ: Zeal

投稿日:

クロスプラットフォームなドキュメントブラウザ、Zeal をご紹介します。

 

Zeal とは?

macOS の Dash というオフライン・ドキュメントブラウザをご存知でしょうか。
Dash は様々な開発言語やスクリプトのクラス定義などのAPIドキュメントを
オフラインで検索して読める macOS/iOS専用のドキュメントブラウザです。

macOS版は USD 26.99 する有料アプリです。

同じドキュメント形式 docset を読める、
クロスプラットフォームなドキュメントブラウザが Zeal です。

非公式でサポートもありませんが macOS でもビルドできます(後述)。

Dash 開発者が提供する 200以上のAPIドキュメント(docset) に加えて、
ユーザー、或いは自分で作ったドキュメントを扱うこともできるので、
クローズドやプライベートなソフトウェア群の自前APIドキュメントも扱うことができます。
ショートカットキーで呼び出して、オフライン環境においても即座に調べることができます。
 

導入

Linux/Windows

基本的に各ディストリビューション/OS に応じた
パッケージマネージャで簡単にインストールできます。
Windows はインストーラーも配布しています。
各OS毎の導入方法はコチラ

以下 Ubuntu の場合

オフィシャルのレポジトリが古い場合は、以下で開発元のPPAレポジトリが利用できます。

Google Adsense



macOS

前述の通り、非公式でサポートは保証されていませんが macOS でもビルドできます。
パッケージマネージャが Homebrew と MacPorts の場合について、
ビルド環境のセットアップからインストールまで手順が
Github上で公開されています。

私自身は 2017/06 に macOS 10.12 Sierra 上でビルドできています。
また執筆時点で 2017/11 まで上記導入手順のページが更新されています。

https://github.com/zealdocs/zeal/wiki/Build-Instructions-for-macOS
 

自作のドキュメントを作成する

doxygen を用いた docset 作成
 

Google Adsense

Google Adsense

-Linux, macOS
-,

Copyright© HEPtech, 2024 All Rights Reserved.