はじめてのプロジェクト¶
目標は、一ページをブラウザーと PDF で読むことです。Guidedog を用意してください。PDF には内蔵コンパイラー、または Typst 0.15.1 以降を使えます。Guidedog のビルドとインストール を参照してください。
macOS では、brew install insanai/guidedog/guidedog でリリースをインストールします。公式 tap が追加され、PDF コンパイラも含まれます。
プロジェクトの作成¶
notes がまだないディレクトリで実行します。
guidedog quickstart notes -q -p "Field Notes" -a "Your name" -v 1.0
Guidedog は設定、最初の RST 文書、編集できるテンプレートを書きます。画像・音声・動画のディレクトリも作成します。既存のプロジェクトは上書きしません。
notes/
conf.toml
index.rst
_templates/
layout.html
book.typ
_static/
guidedog.css
guidedog.js
assets/
images/
audio/
video/
_build/
RST ファイルは内容を、テンプレートは表示を持ちます。quickstart は _templates/layout.html と _templates/book.typ をプロジェクトに直接配置します。外部のテーマやキャッシュには隠されず、いつでも確認して編集できます。
最初のページを書く¶
notes/index.rst を次に置き換えます。
Field Notes
===========
A useful explanation begins with a small example.
Measuring a square
------------------
If the side has length :math:`s`, its area is :math:`s^2`.
.. math::
A = s^2
.. note::
State the units before comparing measurements.
ビルドと確認¶
guidedog build html notes -W
guidedog build pdf notes -W
notes/_build/html/index.html と notes/_build/pdf 内の PDF を開きます。-W は警告でビルドを失敗させるため、文書の検査に残してください。HTML はナビゲーションと本文を、PDF は本の柱やページ番号も含みます。数式は形式ごとに組版します。設定は 数学と証明 を参照してください。
変更してみる¶
guidedog serve notes
表示されたアドレスを開き、ソースを編集して保存し、ブラウザを更新します。Guidedog は HTML を返す前にソースの更新時刻を調べ、進んでいれば再ビルドします。ブラウザの再読み込みは自動送信しません。Ctrl+C で停止します。
何も編集せずに再ビルドします。変更のない文書は再利用し、出力が最新であることを確かめるために全ページを読み直す必要はありません。次は 小さな本を作る です。