asciidoctor

Ubuntu 上で AsciiDoctor を使ってドキュメントを書く

More than 1 year has passed since last update.

 今後システム開発に必要なダイアグラム、UML は PlantUML、その他のダイアグラムは Graphviz や mermaid.js など使うようにし、AsciiDoctor でドキュメントを作成することにしました。Vim のみでドキュメント類を作成できるようにすることで、ドキュメントを git で管理しようと考えたのです。
 ここでは、そのために Asciidoc 関連パッケージのインストールを行う方法を防備録としてメモしておくものとします。

環境

  • Ubuntu MATE 16.04
  • Ruby 2.3.1p112
  • gem 2.5.1
  • Vim 8.0.1002

asciidoctor 関連パッケージのインストール

  • sudo gem install asciidoctor
  • sudo gem install --pre asciidoctor-pdf
  • sudo gem install asciidoctor-pdf-cjk
  • sudo gem install asciidoctor-diagram

ソースファイルの作成

 ryuta46 さんのAsciiDoc と PlantUML と mermaid.js で素敵なテキストベース仕様書ライフにサンプルがあるので参照すると幸せになれます。

コンパイル例

HTML 作成

asciidoctor -r asciidoctor-diagram sample.adoc

pdf 作成

asciidoctor-pdf -n -a toc -r asciidoctor-pdf-cjk -r asciidoctor-diagram --trace sample.adoc