読者です 読者をやめる 読者になる 読者になる

orangain flavor

じっくりコトコト煮込んだみかん2。知らないことを知りたい。

Re:VIEWのDash用Docsetを作った

Re:VIEWはドキュメント作成のためのツールで、DashOS Xでドキュメントを閲覧するためのビューアーです。 タイトルの通り、Re:VIEWのFormat Guideを閲覧できるDash用Docsetを作りました。

f:id:mi_kattun:20160117121429p:plain

使い方

DashのPreferences > Downloads > User Contributedから検索してDocsetをダウンロードできます。

f:id:mi_kattun:20160117121439p:plain

ダウンロードできたらコマンドの名前などで検索するだけです。

f:id:mi_kattun:20160117121652p:plain

作り方

Re:VIEWのFormat GuideをHTMLに変換したものから<h2>タグと<code>タグを抜き出して生成しています。詳しくはDocsetのリポジトリRakefileを参照してください。

機械的に抽出しただけですが、Format Guideが一定のルールに従って書かれているので割りといい感じにコマンドを網羅できているように思います。

ちなみにUser ContributedからダウンロードできるDocsetは英語のFormat Guideから作成したものですが、RakefileMARKDOWN_URLの末尾をformat.mdからformat.ja.mdに変更すると日本語のDocsetも作れると思います。

所感

  • Docsetの作成自体は簡単だが、TOC (Table of Contents) を表示させためにHTMLにアンカーを埋め込まないといけない (=HTMLを変更しないといけない) のはちょっと面倒*1
  • User ContributedなDocsetのマージは速い。
  • Re:VIEWのアイコンが欲しい。

参考

*1:公式のMarkdownのDocsetの中身を見ると、index.htmlにアンカーは埋め込まれておらず、index.html.dashtocというファイルにJSON形式でTOCが格納されていました。書式を真似して*.dashtocファイルを置いてみましたが、TOCは表示されませんでした。