Guidedog / ドキュメント
0.2.0
リーダー、レンダラー、ビルダー¶
リーダーはソース言語を理解し、レンダラーは一つの文書木を書き、ビルダーはプロジェクトを調整して公開する。それぞれ役割が異なる。
| 入力 | リーダー | 経路 |
|---|---|---|
| プロジェクト内の RST | RST と組み込み Sphinx 層 | プロジェクトグラフから HTML、Typst/PDF、テキスト、カタログを生成します。 |
| プロジェクト内の Markdown | MyST 互換の Markdown 層 | 同じプロジェクトグラフとビルダーを使います。 |
convert file.md |
既定は CommonMark | 1 つの文書から HTML または Typst/PDF を生成します。 |
convert file.typ |
ネイティブ Typst アダプター | Guidedoc の意味木の外で Typst をコンパイルします。 |
ビルダー¶
html-
各文書の HTML ファイルと、索引・検索・インベントリを生成します。
dirhtml-
ディレクトリ形式の文書 URL。
singlehtml-
文書ごとの節とローカル参照を含む、1 つのメイン HTML ページです。
pdf-
プロジェクトが定義する Typst の本を生成します。LaTeX ビルダーの別名もこの経路を選びます。
text-
文書ごとのプレーンテキストファイル。
gettext-
翻訳用のメッセージテンプレート。
dummy-
成果物を公開せずにプロジェクトを読み、参照を解決します。
対応範囲は検証の証拠¶
guidedog formats は実行ファイルにあるアダプターを示す。互換性ページは固定テスト群と実プロジェクトの検証を記録する。CommonMark 合格は MyST 全対応を、RST 読み取りは全 Python 拡張の再現を意味しない。Sphinx との互換性 を参照。