Elixirのドキュメント環境を整える
23日目の記事です。
22日は幸せなコンソール - hogeblogでした。
24日は（まだ書いてません）
アドベントカレンダーとはなんだったのか……（スイマセン
Elixirのドキュメント環境を整える
普通に公式のドキュメント見たりIEx使ったりしてもいいんですが、いろいろなライブラリを串刺しで検索したい時にちょっとフベンだったのでメモ
Macにおける串刺しドキュメント検索にはDash.appというアプリがありますが、Linuxでも使えるアプリとしてZealというものがあります。
セットアップするとこんな具合になります
最高ですね。 ということでやったことのメモを書いていきます。
環境
- OS: Linux(Archlinux)
Zealのインストール
Zeal - Offline Documentation Browser
githubにインストールの仕方が書いてあります、が僕が使ったコマンドはこれだけでした。
yaourt -S zeal-git
これで入りました(･ัω･ั)
Archlinuxベンリですね
Elixirのドキュメントのダウンロード
Dashで使われているものをそのまま使えるようで、ぽちぽちとチェックマークをつけてDownloadボタンを押すだけでした。
Phoenixのドキュメントのダウンロード
Dash公式では用意されていないようですが、読み込めるっぽいことが書いてありました。
いやこれじゃ読み込む方法わかんねえ……ということで、適当に検索してたらありました。hex.pmでパッケージが引っかかりました。
ありがてえありがてえと思いながらas-a-global-archiveの方法でインストールしました。
(Installation & Usageの方法だとコケます。{:ex_doc_dash, "~> 0.2.0", only: :docs}がいけなくて、最新は0.3.0です。)
MIX_ENV=docs mix do deps.get deps.compile docs.dash
これで./docsフォルダ以下にフォルダが作成されるので、それをZealで設定しているフォルダにコピーします。デフォルトでは$HOME/.local/share/Zeal/Zeal/docsetsになっていると思います。
Zealを再起動して読み込めていることを確認できたらOKです。
ただ、なんかスタイルが変
期待していたのはElixirのドキュメントのようなスタイルなんですが、どうやら読み込んでいるstylesheet等がオリジナルのものになっている様子。Dash.appにあわせたのでしょうが、個人的には好きでない感じです。
結局どうしたかというと、Zealで読み込むデータベースはもう作れているようなので、
MIX_ENV=docs mix docsでドキュメントを生成しなおしました(手抜き感
時間ができたらちゃんとforkして綺麗に生成したいなあと思いつつ終了です。
dash.vimってﾌﾟﾗｷﾞﾝを見つけたんですが、本当にDash.appにしか対応していないようなのでVimから引くコマンドを後日。
