Guidedog / 문서
0.2.0
리더, 렌더러, 빌더¶
리더는 소스 언어를 이해하고 렌더러는 문서 트리 하나를 출력한다. 빌더는 프로젝트를 조율하고 출력을 게시한다. 서로 다른 책임이다.
| 입력 | 리더 | 경로 |
|---|---|---|
| 프로젝트의 RST | RST와 내장 Sphinx 계층 | 프로젝트 그래프를 HTML, Typst/PDF, 텍스트, 카탈로그로 만듭니다. |
| 프로젝트의 Markdown | MyST 호환 Markdown 계층 | 같은 프로젝트 그래프와 빌더를 사용합니다. |
convert file.md |
기본값은 CommonMark | 문서 하나를 HTML 또는 Typst/PDF로 만듭니다. |
convert file.typ |
네이티브 Typst 어댑터 | Guidedoc 의미 트리 밖에서 Typst를 컴파일합니다. |
빌더¶
html-
문서별 HTML 파일과 색인, 검색, 인벤토리를 생성합니다.
dirhtml-
디렉터리 형식의 문서 URL.
singlehtml-
문서별 절과 로컬 참조를 담은 하나의 주 HTML 페이지입니다.
pdf-
프로젝트가 정의한 Typst 책을 만듭니다. LaTeX 빌더 별칭도 이 경로를 선택합니다.
text-
문서별 일반 텍스트 파일.
gettext-
번역용 메시지 템플릿.
dummy-
결과물을 게시하지 않고 프로젝트를 읽고 참조를 해석합니다.
지원 범위는 검증의 근거¶
guidedog formats는 실행 파일의 실제 어댑터를 보여 준다. 호환성 페이지에는 고정 테스트 모음과 실제 프로젝트 검증이 기록된다. CommonMark 통과가 전체 MyST 지원을, RST 읽기가 모든 Python 확장 동작을 증명하지는 않는다. Sphinx 호환성를 참고한다.