TODESKING
技術ブログ

Javadoc/Scaladocをmarkdown形式に変換するユーティリティ作った

todesking/nyandoc

Javadoc/Scaladocのhtmlをmarkdownに変換するコマンドを作りました。便利です。

scala-libraryの変換済みアーカイブも提供してます:

インストール

Conscriptユーザの人は

1

$ cs install todesking/nyandoc

でインストール可能です。

それ以外の人はプロジェクトをcloneしてきてsbt runするなどしてください。

使い方

1
2

$ nyandoc <source-location> <dest-dir>
$ sbt 'run <source-location> <dest-dir>'

source-locationにあるドキュメントをmarkdown化してdest-dirに保存します。

ドキュメントの探し方

  • Scala API Documentation
  • JDK API Documentation
  • その他のドキュメント
    • mavenで配布されてるライブラリのドキュメントについては、maven.orgからjarが落とせる事が多い。

ctagsを使う

~/.ctags にこのような設定を書いておく

1
2
3
4
5

--langdef=markdown-scala-nyandoc
--regex-markdown-scala-nyandoc=/^#+ .*(def|val|var|type)[[:space:]]+([^ (\[]+)/\2/

--langdef=markdown-java-nyandoc
--regex-markdown-java-nyandoc=/^#+ .*[[:space:]]([a-zA-Z0-9]+(<.+>)?)\(/\1/

ドキュメントのあるディレクトリで以下のコマンドを実行すればタグファイルができます。

1
2

ctags --langmap=markdown-scala-nyandoc:.md -R . # Scalaドキュメント用
ctags --langmap=markdown-java-nyandoc:.md -R .  # Javaドキュメント用

Vimで閲覧する

私はunite.vimを使ってます。

1

:Unite file:.nyandoc/ -default-action=rec

select-document-type

scala-2.11.2を選択

select-document

immutable/Seq.mdを選択

view-document

1

:Unite outline

view-document-outline

便利です。

Comments