첫 프로젝트¶
목표는 간단합니다. 한 페이지를 브라우저에서 보고 같은 내용을 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로 서버를 멈춥니다.
수정 없이 다시 빌드하세요. 변경되지 않은 문서는 재사용하므로, 출력이 최신인지 확인하기 위해 모든 페이지를 다시 읽을 필요가 없습니다. 작은 책 만들기으로 이어 가세요.