Typst

コンパイル

typst compile document.typ              # 1 回コンパイル → PDF
typst compile document.typ output.pdf   # 明示的な出力パス
typst compile document.typ -f png       # PNG 画像として出力
typst compile src/main.typ --root .     # /path インポート用のプロジェクトルートを設定
typst watch document.typ                # 変更時に再コンパイル
typst query document.typ "<label>"      # JSON としてメタデータを抽出 (query.md 参照)

Agent 検証 — 確認する内容で選択 (debug.md 詳細参照):

方法	コマンド	最適な用途
HTML 出力	typst compile doc.typ /dev/stdout -f html --features html 2>/dev/null	テキスト内容、構造、見出し、テーブル
PNG 出力	typst compile doc.typ page-{p}.png -f png	ビジュアルレイアウト、配置、スペース、フォント
pdftotext	typst compile doc.typ && pdftotext doc.pdf -	ページ固有の内容のフォールバック

最小限のドキュメント

#set page(paper: "a4", margin: 2cm)
#set text(size: 11pt)

= Title

Content goes here.

ドキュメントの作成

新しいドキュメントを始めますか? 下記の 例 から最も近いレシピをコピーしてください — 白紙から始めるより高速で、各行は次に読むべきドキュメントを指定しています。

必要な場合	読む
構文、インポート、関数、制御フローを学ぶ	basics.md
データ型、演算子、文字列/配列メソッドを学ぶ	types.md
ページ、見出し、図、レイアウトをスタイル設定	styling.md
テーブル、グリッド、セルスパン、枠線、データテーブル	tables.md
学術論文、参考文献、定理、方程式	academic.md
Markdown または LaTeX から変換	conversion.md
ドキュメントからデータを抽出、マルチパスビルド	query.md

パッケージとテンプレートの開発

必要な場合	読む
状態、カウンタ、ドキュメント内 query()、XML	advanced.md
CLI query、メタデータ出力、マルチパス	query.md
再利用可能なテンプレート関数を作成	template.md
パッケージを作成または公開	package.md
出力を検証 (HTML/PNG/pdftotext、repr)	debug.md
パフォーマンスをプロファイリング (--timings、hotspots)	perf.md

basics.md と types.md は開発者向けの基礎でもあります。

パッケージを見つける

Typst Universe パッケージの埋め込みインデックスを検索 (毎週更新):

python3 scripts/search-packages.py "必要なもの"
python3 scripts/search-packages.py "chart" --category visualization
python3 scripts/search-packages.py --category cv --top 5
python3 scripts/search-packages.py --list-categories

よくあるエラー

エラー	原因	修正方法
"unknown variable"	未定義の識別子	スペルをチェック、使用前に #let を確認
"expected X, found Y"	型の不一致	ドキュメントで関数シグネチャをチェック
"file not found"	不正なインポートパス	パスは現在のファイルから相対的に解決
"unknown font"	フォントがインストールされていない	システムフォントまたはウェブセーフな代替案を使用
"maximum function call depth exceeded"	深いリカージョン	代わりに反復を使用
"can only be used when context is known"	context ラッパーがない	context { ... } でラップ
"unexpected argument"	引数に = の代わりに : を使用	名前付き引数は : 構文を使用: func(name: value)
"variables from outside are read-only"	キャプチャされた変数の変異	ループ蓄積または state() を使用 — advanced.md 参照
"expected content, found string" (その逆)	コンテンツ/文字列型の不一致	[#str-var] を使用して文字列をコンテンツに埋め込む
set/show ルールが効果がない	ルールがコンテンツの後に配置	set/show ルールをターゲットコンテンツの前に配置

例

最も近いスターターをコピーして調整し、コンパイルします。CV、手紙、またはスライドの場合は、パッケージを検索: python3 scripts/search-packages.py --category cv (または letter、presentation)。

例	次の場合に開始	次に読む
basic-document.typ	短いメモまたはメモを作成する場合	basics.md、styling.md
styled-document.typ	ページスタイリングを含むマルチセクションレポート	styling.md、tables.md
template-report.typ	一連のテンプレートを再利用する場合	template.md
tables-showcase.typ	データが多いドキュメント (テーブル、CSV/JSON)	tables.md、types.md
academic-paper.typ	引用、定理、数式を含む論文	academic.md
query-export.typ	メタデータ出力またはマルチパスビルド	query.md
package-example/	公開可能なパッケージ	package.md

依存関係

• typst CLI: https://typst.app からインストール、またはパッケージマネージャー経由
  • macOS: brew install typst
  • Linux: cargo install typst-cli
  • Windows: winget install typst
• pdftotext (オプション): テキストレベルの出力検証用
• Python 3.10+ (オプション): パッケージ検索と検証スクリプト用
• jq (オプション): シェルスクリプトで typst query からの JSON 出力をパース用

API リファレンス検索

Typst API 関数、メソッド、コンストラクタの埋め込みインデックスを検索:

python3 scripts/search-api.py "image width fit"
python3 scripts/search-api.py "color lighten" --kind method
python3 scripts/search-api.py --name str.position -v
python3 scripts/search-api.py "rightarrow" --kind symbol   # LaTeX 名も動作
python3 scripts/search-api.py --list-categories

エコシステムツール

エコシステムツール: tinymist (LSP/エディタ)、typstyle (フォーマッタ)、typst-package-check (パッケージ検証)、tytanic (ビジュアルテストランナー)。パッケージツールの詳細については package.md を参照。