Guidedog / ドキュメント 0.2.0

Guidedog マニュアル

一度書き、分かりやすく説明し、ウェブと紙に届ける。

Guidedog は reStructuredText と Markdown のソースから HTML サイトと PDF の本を作る文書生成ツールです。Python 環境や外部の LaTeX は不要です。変換エンジンは Guidedoc と呼ばれ、PDF の組版には Typst を使います。サイトは Guidedog が直接生成します。

小さなプロジェクトに必要なのは、ソース文書、目次、conf.toml の 3 つです。はじめてのプロジェクト から始めてください。作業別の手順は 実践的な手順、正確な規約は リファレンス にあります。

図 1 1 つのソースプロジェクトから、2 つの出版形式へ。

学ぶ

• チュートリアル

  • はじめてのプロジェクト

  • 小さな本を作る

• トピックガイド

  • 文書を書く

  • ドメイン

  • プロジェクトの仕組み

  • 数学と証明

  • 図で説明する

  • 読みやすい組版

  • テンプレート

  • 画像、動画、音声、ダウンロード

  • 国際化

  • 他のプロジェクトへのリンク

  • オブジェクト型の宣言

  • autodoc による Python のドキュメント作成

  • Odin の文書化

使う

• 実践的な手順

  • Guidedog のビルドとインストール

  • 文書のビルドと公開

  • Sphinx プロジェクトの移行

  • コードベースの文書化

  • この文書の保守

• リファレンス

  • コマンドラインリファレンス

  • 設定リファレンス

  • リーダー、レンダラー、ビルダー

  • エラーメッセージ

  • Sphinx との互換性

理解する

• 内部の仕組み

  • Guidedoc エンジン

  • アルゴリズムより先に不変条件

  • 完全な世代を公開する

  • メモリと所有権

• このマニュアルについて

  • ビルドの検証記録

• Guidedog

  • プロジェクトを始める

  • インストール

  • ソースからビルドする

  • Guidedog で翻訳する

  • 読む・組み込む

  • 謝辞とライセンス

API リファレンス

• API Reference