Skip to content

Commit

Permalink
fix typo and convert markdown to asciidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
h1romas4 committed Sep 20, 2023
1 parent 5eec3f0 commit 4f751e7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/docs/asciidoc/Chapter02/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ build.gradle <7>
<3> HTML 出力とプレビュー用のスタイルシートです。文書に合わせて修正することができます。
<4> PDF 文書に変換する際に使われるスタイル定義です。文書に合わせて修正することができます。
<5> PDF 文書に埋め込みされるフォントファイルを配置します。``pdf-theme.yml`` からファイル名で参照されています。TrueType フォント ``.ttf`` が指定できます。
<6> ``src/docs/asciidoc/index.adoc`` から参照される子文書です。``build.gradle`` による画像パス解決のためフォルダ名は ``Chapter{number}`` とします。
<6> ``src/docs/asciidoc/index.adoc`` から参照される子文書です。``build.gradle`` による画像パス解決のためフォルダ名は ``Chapter\{number\}`` とします。
<7> 文書を変換する Gradle ビルドスクリプトです。Asciidoc 文書や画像パスの設定があります。

本構成を元に執筆したい文書に合わせカスタマイズしていきます。文書ファイルの編集や閲覧は VS Code のリアルタイムプレビューで確認しながら行うと分かりやすいでしょう。
Expand Down Expand Up @@ -840,7 +840,7 @@ image::2023-09-06-10-41-11.png[pdfwidth=60%]

==== `.github/workflows/release.yml`

git のバージョンタグを push する操作で、GitHub のリリースページにソースコード一式と、GitHub Actions 上で変換処理された `docs` 配下のファイルを `{doc-name}-{verison}-by-*.tar.gz` アーカイブファイルとして GitHub のリリースダウンロードページに掲載する GitHub Actions 定義です。
git のバージョンタグを push する操作で、GitHub のリリースページにソースコード一式と、GitHub Actions 上で変換処理された `docs` 配下のファイルを `\{doc-name\}-\{verison\}-by-*.tar.gz` アーカイブファイルとして GitHub のリリースダウンロードページに掲載する GitHub Actions 定義です。

ファイル名の `by-*` 以下の部分にはビルドした環境名が `by-windows-latest-java-11` や `by-macos-latest-java-17` のような形で付与されます。通常はひとつの環境でビルドした文書だけリリースできれば十分ですので、利用する時は次のマトリクスを変更してビルド環境を絞ってください。

Expand Down

0 comments on commit 4f751e7

Please sign in to comment.