archify 図の正典と埋め込み定型¶
このディレクトリの .json が図の正典です。.html は node scripts/render-archify.mjs
でビルド時に生成する成果物で、コミットしません(.gitignore)。JSON はサイトから
除外し(mkdocs.yml の exclude_docs)、HTML はそのまま配信します。
ファイル名は <名前>.<型>.json(型 = architecture / workflow / sequence /
dataflow / lifecycle)とし、同じ名前で <名前>.<型>.html を生成します。
JSON の diagram_type とファイル名の型は一致させます(不一致は render が失敗します)。
埋め込みの定型¶
iframe の src は生成後 URL 基準、Markdown リンク(全画面で開く)はソース基準で
書きます(この非対称に注意)。mkdocs は use_directory_urls: true のため通常の
<page>.md は <page>/index.html に出力されますが、Markdown リンクは mkdocs が
書き換えるのに対し、生 HTML の src はそのまま配信されるため、同じ相対パスでは
解決先が 1 段ずれます(mkdocs build --strict は生 HTML の src を検証しません)。
| ページの種類 | iframe src |
Markdown リンク |
|---|---|---|
通常ページ(docs/operations-manual/<page>.md 等) |
../../diagrams/archify/<名前>.<型>.html |
../diagrams/archify/<名前>.<型>.html |
サブディレクトリの索引ページ(docs/<dir>/index.md・README.md) |
../diagrams/archify/<名前>.<型>.html(1 段浅い) |
../diagrams/archify/<名前>.<型>.html(1 段浅い) |
この README(docs/diagrams/archify/) |
_samples/<名前>.<型>.html |
_samples/<名前>.<型>.html |
サイトルートの docs/index.md から埋め込む場合は ../ を付けず
diagrams/archify/<名前>.<型>.html とします(iframe・リンクとも)。
通常ページ用の例:
<iframe src="../../diagrams/archify/<名前>.<型>.html" title="<要約>" loading="lazy" style="width:100%;height:640px;border:1px solid var(--md-default-fg-color--lightest);border-radius:6px"></iframe>
直下に [全画面で開く](../diagrams/archify/<名前>.<型>.html) と 1 行要約を置きます。
回帰サンプル¶
JWNET Web-EDI 要求から結果取込までの流れ(archify 変換サンプル・nav には載せない)。