Published on

AsciiDocとplantUML

Authors
  • avatar
    Name
    Kikusan
    Twitter

AsciiDoc

markdownと並ぶ軽量マークアップ言語、includeで外部ファイルの読み込みができる。

https://asciidoc.org/

記法

plantUML

コードベースのUML作成ツール。

https://plantuml.com/ja/

記法

VSCodeでの使用方法

AsciiDocExtensionをインストール.
設定からkrokiを有効にすることで、plantUMLもadoc内で使用可能になる。

Extensionの説明とasciidoctor-krokiの説明の通り、
krokiはデフォルトでプレビュー、エクスポート時kroki.ioに飛んでいくため、自分のサーバを使う必要がある場合は、kroki-server-urlを設定する。

{
  "asciidoc.use_kroki": true,
  "asciidoc.preview.attributes": {
    "kroki-server-url": "http://localhost:9999"
  }
}

プレビューはctrl+k, vで可能。
ExportはコマンドパレットのAsciiDocからhtml,pdfで可能。krokiのURLが入るため注意。

gradleでのビルド

gradleプラグインを使用する。 https://asciidoctor.github.io/asciidoctor-gradle-plugin/master/user-guide/

以下のbuild.gradleによって、asciidoctorタスクでdocsの配下をbuild/docsに生成する。

plugins {
    id 'org.asciidoctor.jvm.convert' version '3.3.2'
}

repositories {
    mavenCentral()
}

asciidoctor {
  sourceDir  file('docs')
  sources {
    include '**/*'
  }
  outputDir  file('build/docs')
}

asciidoctorj {
    modules {
       diagram.use() 
       diagram.version '1.5.16' 
    }
}

上記でplantUMLの図を生成するにはgraphvizが必要だったため、
筆者はMac環境でbrew install graphvizを実行するとうまく図が差し込まれるようになりました。

https://github.com/asciidoctor/asciidoctor-gradle-examples/pull/24

Discuss on Twitter