Guidedog / 문서 0.2.0

Guidedog 설명서

한 번 쓰고, 잘 설명하고, 웹과 종이에 게시하세요.

Guidedog은 reStructuredText와 Markdown 소스로 HTML 사이트와 PDF 책을 만드는 문서 생성기입니다. Python 환경이나 별도의 LaTeX 설치가 필요하지 않습니다. 변환 엔진의 이름은 Guidedoc입니다. PDF는 Typst로 조판하며, 웹사이트는 Guidedog이 직접 생성합니다.

작은 프로젝트에는 소스 문서, 목차, conf.toml 세 가지가 필요합니다. 첫 프로젝트부터 시작하세요. 구체적인 작업은 실용적인 작업, 정확한 규약은 참조를 참고하세요.

그림 1 하나의 소스 프로젝트, 두 가지 출판물.

배우기

• 따라 하기

  • 첫 프로젝트

  • 작은 책 만들기

• 주제별 안내

  • 문서 작성

  • 도메인

  • 프로젝트의 동작 방식

  • 수학과 증명

  • 개념을 설명하는 다이어그램

  • 읽기 위한 조판

  • 템플릿

  • 이미지, 동영상, 오디오, 다운로드

  • 국제화

  • 다른 프로젝트로 연결

  • 객체 타입 선언

  • autodoc으로 Python 문서 작성하기

  • Odin 문서화

활용하기

• 실용적인 작업

  • Guidedog 빌드와 설치

  • 문서 빌드와 게시

  • Sphinx 프로젝트 옮기기

  • 코드베이스 문서화

  • 이 문서 관리하기

• 참조

  • 명령줄 참조

  • 설정 참조

  • 리더, 렌더러, 빌더

  • 오류 메시지

  • Sphinx 호환성

이해하기

• 내부 구조

  • Guidedoc 엔진

  • 알고리즘에 앞서는 불변식

  • 완전한 출력 세대 게시

  • 메모리와 소유권

• 이 설명서에 관하여

  • 빌드 검증 기록

• Guidedog

  • 프로젝트 시작

  • 설치

  • 소스에서 빌드

  • Guidedog으로 번역

  • 문서 읽기와 임베딩

  • 기여자와 라이선스

API 참조

• API Reference