Awesome

Asciidoc Edit Environment (Dev Contaienr)

INDEX

• ABOUT
• ENVIRONMENT
• PREPARING
• HOW TO USE
• ERROR LOG

ABOUT

tiny asciidoc sample.

Reference: Asciidoctor Docs

ENVIRONMENT

asciidoctor gradle plugin

Gradleでbuildすることでasciidoctorでビルドするよりもライブラリの管理や依存関係の設定が楽になる。

• asciidoctor-gradle-glugin guide
• Official repository

[!NOTE] gradlew: 特定のversionのGradleを作るためのもの。今回の場合はDockerのgradle imageを使っているためGradleのversionは固定だが，GitHub Actionsで実行することを見据えて追加した。

 # 作成
 gradle wrapper
 # 削除
 rm gradlew
 rm gradlew.bat
 rm -rf gradle/wrapper/

PlantUML

• PlantUMLで図を生成するためにはlibXext.so.6が必要。Dockerfileにaptで追加している。
• Asciidocに直接.puファイルを埋め込んでいる。
  • asciidoctor-diagramが必要(build.gradleに記載)

GitHub Pages

作成したAsciiDocをgithubでホストする。 例: https://ryosukedtomita.github.io/asciidoc_env/test.html

初期設定

• リポジトリの設定からBuild and deploymentをGithub Actionsに変更
• リポジトリの環境変数設定からfeature/github-pagesを追加

PREPARING

1. install VSCode, Docker
2. install VSCode Extensions Dev Container

HOW TO USE

html and svg (created with PlantUML) are stored under build/.

just build html

docker buildx bake
docker compose up

use asciidoc Dev Container

Open this repository and Rebuild and Reopen in Container

# create html
gradle asciidoctor

# delete html
gradle clean

ERROR LOG

PlantUMLの日本語が重なる

Dev Containerに日本語フォントが入っていないのが原因。素晴らしいQiita