添付ファイル
証明、仕様、長い導出は、Markdown で書くより組版したほうが適しています。Luna Flow はそれらを Typst ドキュメントとして doc/attachments/ に置き、サイトのビルド時に PDF へコンパイルし、必要なときに開けるリーダーでページ内に表示します。
ファイルの置き場所
doc/attachments/ 内のものはすべて、全言語で共有されます。
| ファイル | 公開形式 |
|---|---|
<name>.typ | <name>.pdf |
<name>/main.typ | <name>.pdf（複数ファイルに分割された文書の場合） |
<name>.<locale>.typ または <name>/main.<locale>.typ | そのロケール用の <name>.pdf |
| その他のファイル | ファイルそのもの |
PDF ではなく Typst のソースをコミットしてください。継続的インテグレーションがビルドのたびにすべてのドキュメントをコンパイルするため、公開される PDF は常にソースと一致します。図や他のツールで作成した PDF など、Typst 以外のファイルはそのまま公開されます。
Typst ドキュメントは doc/attachments/ をプロジェクトルートとしてコンパイルされるため、そこから共有テンプレートをインポートできます。ビルド環境には Typst の標準フォントと Noto CJK フォントが用意されています。
名前の付け方
名前は小文字とし、単語の間はアンダースコアでつなぎます。画像は Blender マニュアルの規則に従います。名前は画像を使うページのパスで始め、パスの区切りには _、各部分の中では - を使います。たとえば core/api.md の図なら core_api_hom-composition.svg です。このような名前を付けたフラットなディレクトリなら、各ファイルがどのページに属するかがひと目でわかります。
ドキュメントの埋め込み
Typst のソースにリンクします。リンクが段落内の唯一の内容であれば、ページにはその場で展開できるリーダーが表示されます。
[Formal specification of the QED kernel](../attachments/qed_formal_spec.typ)#page=12 を付けると、指定したページでドキュメントを開きます。文中のリンクは通常のリンクのままで、PDF を直接開きます。
リーダーはリンクテキストをタイトルとして表示し、ページを必要に応じて描画し、拡大縮小、新しいタブで開く、ダウンロードの機能を備えています。GitHub 上では同じリンクが Typst のソースを開くため、そこでもページは問題なく使えます。
ドキュメントにロケール別の版がある場合も、どの言語からも同じ名前にリンクします。サイトはページのロケールに合った版を選び、なければロケール接尾辞のない版にフォールバックします。
画像
Markdown の画像構文で、説明を付けて画像を埋め込みます。
図には SVG、スクリーンショットには PNG を使うことを推奨します。すべての画像に代替テキストを付けてください。代替テキストはページと一緒に翻訳されます。