言語仕様などのドキュメントを高速で参照できる「Dash」

つみきのフロントエンドエンジニア、高松です。

前々から気にはなっていたのですが、最近「Dash」を使いはじめてなかなか便利だと感じたので、使い方を簡単に紹介してみたいと思います。

Dashとは

画像1

Dash for OS X - API Documentation Browser, Snippet Manager - Kapeli

Dashとは、各言語やライブラリ、ツールなどのドキュメントをオフラインで高速に検索できるMac用のアプリケーションです。

公式サイトによるとDashは150以上のドキュメントをサポートしているとのことです。
また、まだサポートされていないものについてもユーザーがドキュメントセットを作成して寄贈しているので、主要なドキュメントはほとんど参照できるのではないでしょうか。(自分でドキュメントセットを作成してもよいです)

画像2

対応ドキュメントの一例(公式サイトより)

また今回は紹介しませんが、Dashにはコードスニペットを管理する機能もあります。

Dashの使い方

オフラインでドキュメントを参照するために、ドキュメントをダウンロードします。

Preferences -> Downloadsでダウンロード画面を開き、参照したいドキュメントのセットを選んでいきます。
ReactやVue.jsなどは、現状「User Contributed」のものを利用することになります。

画像3

ドキュメントをダウンロードしたら、あとはDashの画面でドキュメントを参照するだけです。

画像4

左上の検索欄を使って、すべてのドキュメントを検索できます。

また、「CoffeeScriptのFunctionについて参照したい」というように特定のドキュメント内を検索したい場合は、「coffee:function」というように各ドキュメントのキーワードを入れて検索します。
このキーワードはPreferences -> Docsetsから変更することも出来ます。

検索するだけなので、簡単に使えますね!

他のアプリケーションとの連携

Dashを他のアプリケーションと連携させることで、より便利に使うことができます。

下記のアプリケーションに対応しているので、いくつか連携してみます。

画像5

対応アプリケーション(公式サイトより)

「Alfred」と連携

ショットカットキーを設定すると、Dash単体でも瞬時にDashを立ち上げて検索できるのですが、すでにAlfredを利用している人はAlfredで検索できた方が使いやすいかと思います。

AlfredのWorkflowを使うので、AlfredにはPowerpackが必要ですが、設定するとAlfredのウインドウから検索することが出来ます。

画像6

Preferences -> IntegrationからAlfredを選んでWorkflowをimportするだけなので、設定に手間もかかりません。

「Sublime Text」と連携

下記のパッケージを入れることで、Sublime Textとも連携することができます。

DashDoc - Packages - Package Control

ソース上で調べたい箇所を選択してcontrol + Hとするだけで、Dash内のドキュメントの該当箇所を開いてくれます。

シンタックスを判断して検索するドキュメントを絞り込んでくれるので、例えば.coffeeファイルでifを選択して前述のショートカットキーを使うと、JavaScriptドキュメントのifの項よりもCoffeeScriptドキュメントのifの項を優先して表示してくれます。
(あくまで優先されるだけで両方検索結果に表示されますし、この機能をオフにすることも可能です)

「PopClip」と連携

PopClip用のExtensionも用意されており、下記からダウンロードすることができます。

PopClip Extensions

技術系のブログを見ているときなど、エディタ以外(Webブラウザなど)でコードを見る機会は意外に多いかと思います。

これを設定しておくと、検索する範囲を選択してDashボタンを押すだけですぐにDash上で検索することができます。

画像7

まとめ

以上、Dashの使い方をざっくりと紹介してみました。

エンジニアの方々は仕事中に言語やライブラリのドキュメントを参照する機会が多いかと思います。
回数の多い作業を少しでも効率化できることを考えると、使ってみる価値は十分にあると思いますので、是非試してみてください。

スマホアプリ制作、Web制作、UIコンサルなどのご依頼はこちら

お問い合わせ