Skip to content
사용 사례문서화워크플로

README를 PDF로 만드는 7가지 실용 사례

고객 전달, 강의 자료, 감사 스냅샷 등 README PDF가 저장소 링크보다 나은 상황과 각 상황에 맞는 테마 및 설정을 정리합니다.

저장소 링크는 이미 GitHub에서 생활하는 사람과 문서를 공유하는 데는 훌륭한 방법입니다. 그 외 모든 사람과 문서를 공유하는 데는 좋지 않습니다. 검토자는 맥락을 잃고, 고객은 계정을 만들고 싶어 하지 않으며, URL은 아카이브가 아닙니다. PDF는 배포 문제를 해결하지만, 의도적으로 만들어야만 그렇습니다.

md2pdf는 좁은 작업 흐름을 중심으로 만들어졌습니다. 공개 저장소, 로컬 파일 또는 클립보드에서 Markdown을 가져오고, GitHub Flavored Markdown으로 렌더링하고, 인쇄 스타일시트를 적용한 뒤 브라우저의 “PDF로 저장” 대화상자로 보냅니다. 이 좁은 범위가 유용합니다. 같은 도구가 서버도, 계정도, 업로드도 없이 다섯 페이지짜리 고객 전달 문서와 쉰 페이지짜리 강의 자료를 모두 처리할 수 있다는 뜻이니까요.

아래는 이 작업 흐름이 제값을 하는 일곱 가지 상황과, 각 상황을 성공시키는 설정 및 준비 방법입니다.

1. 고객 및 이해관계자 전달

고객은 프로젝트 개요를 읽기 위해 저장소 접근 권한을 원하는 경우가 거의 없습니다. 열어 보고, 동료에게 전달하고, 회의에서 주석을 달 수 있는 문서를 원합니다. README PDF는 종종 적절한 수준의 디테일을 제공합니다. 범위, 아키텍처 노트, 설정 단계, 스크린샷, 알려진 제한 사항을 한 파일에 담습니다.

권장 설정:

  • 테마: 외부 독자에게는 Business, 기술적인 고객에게는 Clean.
  • 목차: 네 페이지를 넘는 문서는 켜기.
  • 페이지 크기: 고객의 지역에 맞추기 — 대부분의 유럽과 아시아는 A4, 미국과 캐나다는 Letter.
  • 소스: 공개 저장소라면 가져오기, 그렇지 않으면 Markdown을 붙여넣거나 README 파일 업로드.

중요한 준비:

  • 내보내기 전에 내부 티켓 링크, 스테이징 URL, 자격 증명을 제거하세요. 도구가 문서를 업로드하지는 않지만 PDF는 여전히 전달될 수 있는 파일입니다.
  • 상대 이미지 경로를 실제로 존재하는 저장소 경로로 바꾸세요. md2pdf는 저장소를 가져올 때 이를 해석하지만, 원본 이미지가 깨져 있으면 PDF에서도 깨져 있습니다.
  • README가 변경 로그가 아니라 요약으로 시작하는지 확인하세요. 전달 문서는 무엇이 바뀌었는지 말하기 전에 프로젝트가 무엇인지 알려야 합니다.
  • README가 설정 지침과 아키텍처 배경을 섞고 있다면 짧은 “이 문서를 읽는 방법” 문단을 추가하세요.

고객이 검토 중 특정 페이지를 언급할 것 같으면 브라우저의 페이지 번호 옵션을 사용하세요. 앱의 인쇄 스타일시트는 페이지 번호를 자체적으로 추가하지 않습니다. 브라우저의 머리글과 바닥글이 페이지 번호를 얻는 가장 간단한 방법입니다.

2. 오프라인 아카이브와 릴리스 문서

저장소에만 존재하는 문서는 독자 발밑에서 바뀝니다. 특정 시점의 릴리스가 어땠는지 스냅샷이 필요할 때 PDF는 안정적인 결과물입니다. 바이너리 옆에 보관하거나, 릴리스 기록에 첨부하거나, 나중에 README가 다시 작성될 걱정 없이 프로젝트 아카이브에 둘 수 있습니다.

권장 설정:

  • 테마: Clean.
  • 목차: 켜기.
  • 파일 이름: 저장소, 릴리스 태그 또는 커밋, 날짜를 포함하세요. 예: acme-api-v2.4.0-readme-2026-10-02.pdf.
  • 소스: 공개 저장소를 가져온 뒤 의도한 README를 내보내는지 확인하세요. 앱은 기본 브랜치를 읽으므로, 고정된 태그나 커밋이 필요하면 붙여넣기 경로를 사용하세요.

중요한 준비:

  • 문서 어딘가나 파일 이름에 소스를 기록하세요. 버전이 없는 PDF는 그저 날짜 없는 첨부 파일 하나일 뿐입니다.
  • 아카이브 전에 링크를 확인하세요. blob 링크는 저장소의 기본 브랜치를 계속 가리킵니다. 태그나 커밋의 진짜 스냅샷이 필요하면 가져오기 흐름 대신 해당 버전의 README를 붙여넣고, 커밋 해시를 바닥글 줄이나 함께 두는 릴리스 기록에 남기세요.
  • 브라우저 머리글과 바닥글에 로컬 파일 경로나 내부 호스트 이름이 포함된다면 끄세요. 아카이브는 자체 완결적이어야 하며, 그것을 만든 머신을 노출해서는 안 됩니다.
  • 아카이브를 재현 가능하게 유지해야 한다면 Markdown 소스를 PDF와 함께 보관하세요. PDF는 결과물이고 Markdown은 레시피입니다.

검토 단계에서 Dark 테마를 쓰기에도 좋은 사례입니다. 화면에서 미리보기를 읽은 뒤, 인쇄 스타일시트가 종이용으로 밝게 바꾼다는 점을 알고 내보내세요. 화면 모습이 프린터에 그대로 전달된다고 가정하지 말고 최종 PDF를 확인하세요.

3. 학술 제출물과 강의 패킷

학생과 강사는 제출하거나 하나의 문서로 배포해야 하는 Markdown 노트, 프로젝트 문서, 읽기 자료를 자주 가지고 있습니다. Academic은 제품 README와 다른 역할을 합니다. 넉넉한 본문, 절제된 코드 블록, 랜딩 페이지처럼 보이지 않는 레이아웃이 필요합니다.

권장 설정:

  • 테마: Academic.
  • 목차: 섹션이 세 개를 넘는 문서는 켜기.
  • 페이지 크기: 기관의 요구 사항을 따르세요. 미국 외 지역에서는 A4가 일반적이고, 미국에서는 Letter가 일반적입니다.
  • 소스: 작업물이 공개되지 않았다면 Markdown을 업로드하거나 붙여넣으세요. 변환하려고 미공개 작업물을 공개 저장소에 올리지 마세요.

중요한 준비:

  • 내보내기 전에 제목 계층을 확인하세요. 단계를 건너뛴 강의 자료는 혼란스러운 목차를 만듭니다.
  • Academic은 본문을 양쪽 정렬합니다. 아주 긴 URL, 코드 식별자, 수식은 어색한 간격을 만들 수 있습니다. 긴 URL은 참조 스타일 링크로 나누거나 각주 같은 섹션으로 옮기세요.
  • 코드 블록은 짧게 유지하세요. 이 테마는 인쇄가 잘 되는 밝은 코드 배경을 사용하지만, 120자 줄은 여전히 페이지를 넘칩니다.
  • 문서에 인용이 포함된다면 Markdown의 참고문헌 섹션으로 유지하세요. md2pdf는 텍스트를 렌더링할 뿐 인용 형식을 관리하지 않습니다.
  • 제출 전에 초안을 인쇄해 보세요. 양쪽 정렬 텍스트와 세리프 서체는 미리보기와 종이에서 다르게 보일 수 있습니다.

변환이 클라이언트 측에서 이루어지므로 미공개 노트와 논문 초안은 브라우저를 떠나지 않습니다. 이는 “문서를 저희 변환기에 붙여넣으세요”라는 서비스에 비해 의미 있는 장점입니다.

4. 내부 검토 패킷과 릴리스 노트

엔지니어링 팀은 설계 검토, 릴리스 준비 점검, 사후 분석 후속 조치를 위해 하나의 문서가 필요한 경우가 많습니다. 소스는 이미 README나 문서 페이지로 존재할 수 있습니다. 이를 PDF로 바꾸면 회의의 고정된 안건과 검토자가 무엇을 보았는지에 대한 기록이 생깁니다.

권장 설정:

  • 테마: 엔지니어링 검토에는 Clean, 여러 부서가 참여하는 청중에는 Business.
  • 목차: 켜기.
  • 소스: 공개 저장소 가져오기, 저장소가 비공개라면 Markdown 붙여넣기.

중요한 준비:

  • 결정 사항이나 요청을 맨 위에 두세요. 배경 설명 세 페이지로 시작하는 검토 패킷은 검토되지 않습니다.
  • 미해결 질문을 명시적으로 표시하세요. PDF 형식은 인쇄본에 주석을 달기 쉽게 하지만, 질문이 눈에 보일 때만 그렇습니다.
  • 비밀과 고객 식별자를 제거하세요. 도구가 문서를 어디로도 보내지 않지만, 검토 패킷은 전달되는 경향이 있습니다.
  • 파일 이름에 커밋이나 문서 버전을 포함하세요. 버전이 없는 검토 노트는 나중에 대조하기 어렵습니다.
  • 문서에 작업 목록이 포함된다면 어떻게 렌더링되는지 확인하세요. GitHub Flavored Markdown 작업 목록은 지원되지만, 긴 체크리스트는 페이지에 걸쳐 나뉠 수 있습니다. 관련 항목은 함께 두세요.

가져오기 흐름은 비공개 저장소를 지원하지 않습니다. 내부 작업에는 붙여넣기나 업로드 경로가 실용적인 선택입니다. 이는 제품에 임시로 붙인 우회 방법이 아니라, 공개 URL에서 읽어서는 안 되는 자료를 다루는 의도된 방법입니다.

5. 워크숍 유인물과 컨퍼런스 자료

저장소에 있는 워크숍 실습은 네트워크 접근, GitHub 계정, 작동하는 노트북을 전제합니다. 인쇄된 유인물은 그중 어느 것도 전제하지 않습니다. 튜토리얼, 컨퍼런스 세션, 교실 실습에서는 PDF가 종종 강의실에서 가장 신뢰할 수 있는 사본입니다.

권장 설정:

  • 테마: 세련된 유인물에는 Business, 코드가 많은 실습에는 Clean.
  • 목차: 유인물에 여러 실습이 있다면 켜기.
  • 페이지 크기: 행사장 프린터에 맞추세요. A4와 Letter가 모두 흔하니 쉰 부를 인쇄하기 전에 확인하세요.
  • 소스: 공개 워크숍 저장소는 가져오기, 비공개 초안은 업로드.

중요한 준비:

  • 흑백을 염두에 두고 디자인하세요. 색상만으로 섹션을 구분하는 테마는 흑백 프린터에서 그 구분을 잃습니다.
  • 코드 줄은 약 80자 이내로 유지하세요. 유인물은 27인치 모니터가 아니라 팔 길이 거리에서 읽힙니다.
  • 독자에게 최신 버전이 필요하다면 라이브 저장소로 가는 짧은 URL이나 QR 코드를 추가하세요. PDF는 안정적인 사본이고, 저장소는 살아 있는 사본입니다.
  • 페이지 수를 확인하세요. 마흔 페이지짜리 유인물은 여섯 페이지짜리 실습지와 다른 결과물입니다. 목차와 제목을 활용해 무엇이 들어갈지 결정하세요.
  • 행사 전에 한 부를 인쇄해 보세요. 화면에서 괜찮아 보이던 브라우저 인쇄 설정이 행사장 프린터에서 다른 여백을 만들 수 있습니다.

앱의 인쇄 스타일시트는 깔끔한 페이지 나눔을 위해 설계되었지만, 특정 프린터가 여백을 어떻게 처리하는지는 알 수 없습니다. 한 번의 테스트 인쇄가 여전히 최고의 품질 점검입니다.

6. 연구비, 포트폴리오, 취업 지원

지원서는 프로젝트 개요, 기술 보고서, 포트폴리오 샘플을 하나의 첨부 파일로 요구하는 경우가 많습니다. README PDF는 검토자가 GitHub 계정 없이 열 수 있는 형태로 프로젝트 자체의 문서를 보여주기 때문에 이 상황에 잘 맞습니다.

권장 설정:

  • 테마: 일반 청중에게는 Business, 연구 중심 지원에는 Academic.
  • 목차: 문서가 몇 페이지보다 길면 켜기.
  • 페이지 크기: 지원 안내를 따르세요.
  • 소스: 공개 저장소 가져오기, 프로젝트가 비공개라면 Markdown 붙여넣기.

중요한 준비:

  • 가장 관련 있는 프로젝트를 맨 앞에 두세요. 지원서 검토자는 처음 두 페이지까지만 읽을 수 있습니다.
  • 의미를 더하지 않는 배지는 제거하세요. 빌드 배지가 가득한 벽은 포트폴리오 첨부 자료에서 잡음입니다.
  • 스크린샷과 다이어그램에 대체 텍스트가 있고 실제로 표시되는지 확인하세요. 깨진 이미지는 이미지가 없는 것보다 나쁩니다.
  • PDF에서 링크를 클릭할 수 있는지 확인하세요. 라이브 프로젝트로 클릭해 이동할 수 없는 검토자는 맥락을 잃습니다.
  • 파일 크기를 적절히 유지하세요. 이미지가 많은 아주 큰 PDF는 지원 포털의 업로드 한도에 걸릴 수 있습니다.

Business 테마의 세리프 서체가 기술 프로젝트를 원본 저장소를 쏟아낸 것보다 전문적인 문서처럼 읽히게 하는 데 도움이 되는 경우이기도 합니다. 지원서를 이끄는 것은 여전히 내용이며, 테마는 어조만 설정합니다.

7. 감사 및 컴플라이언스 스냅샷

때로는 PDF의 목적이 처음부터 끝까지 읽히는 것이 아닙니다. 특정 날짜에 문서가 무엇을 말했는지 증명하는 것입니다. 접근 제어, 데이터 처리, 운영 절차를 설명하는 README는 변경 불가능한 결과물로 포착될 때 감사 패킷의 유용한 일부가 될 수 있습니다.

권장 설정:

  • 테마: Clean.
  • 목차: 긴 문서는 켜기.
  • 파일 이름: 저장소, 커밋, 캡처 날짜를 포함하세요.
  • 소스: 공개 저장소를 가져오거나, 검토한 정확한 Markdown을 붙여넣으세요.

중요한 준비:

  • 소스 버전을 기록하세요. 커밋 참조가 없는 PDF는 기반 README가 바뀔 수 있으므로 약한 증거입니다.
  • PDF를 시스템 오브 레코드로 취급하지 마세요. 이는 문서의 스냅샷이며 로그, 정책, 서명된 증명을 대체하지 않습니다.
  • 문서에 비밀, 내부 호스트 이름, 개인 데이터가 없는지 확인하세요. 감사 패킷은 원본 저장소보다 더 널리 공유되는 경우가 많습니다.
  • Markdown 소스와 PDF를 함께 보관하세요. 누군가 캡처에 의문을 제기하면 소스가 결과물이 어떻게 만들어졌는지 설명합니다.
  • 소스가 바뀌면 다시 내보내세요. 최신 파일 이름을 가진 오래된 PDF는 분명히 날짜가 표시된 PDF보다 나쁩니다.

PDF가 잘못된 형식일 때

PDF는 배포 형식이지 협업 형식이 아닙니다. 다음 경우에는 잘못된 선택입니다:

  • 문서가 매일 바뀌고 독자가 최신 버전을 필요로 할 때. 대신 저장소로 링크하거나 일정에 따라 PDF를 생성하세요.
  • 콘텐츠가 상호작용 요소, 라이브 데이터, 임베드된 동영상에 의존할 때. PDF는 그 모든 것을 평면화합니다.
  • 저장소가 비공개이고 받는 사람이 소스를 탐색해야 할 때. PDF는 스냅샷을 줄 뿐 접근 권한을 주지 않습니다.
  • 저장소에서도 충분히 잘 읽히는 짧은 한 페이지 문서일 때. 추가 단계가 그만한 가치가 없을 수 있습니다.
  • 추적되는 댓글과 제안이 필요할 때. 협업 문서 도구를 사용하세요. PDF 주석은 검토 워크플로를 대체하지 못합니다.

이 도구는 의도적으로 문서 플랫폼이 아닙니다. 이미 가지고 있는 문서를 휴대 가능한 문서로 바꿀 뿐입니다. 언제 쓰지 말아야 하는지 아는 것도 잘 쓰는 방법의 일부입니다.

5분 사전 점검 체크리스트

점검 항목 중요한 이유
소스가 올바른 저장소 또는 파일인가 프로젝트 이름이 틀린 PDF는 PDF가 없는 것보다 나쁩니다
제목 계층이 일관적인가 목차와 페이지 구조를 좌우합니다
이미지가 표시되는가 저장소 기준 경로는 저장소를 가져와야 합니다
코드 줄이 너무 넓지 않은가 넓은 코드 블록이 가장 흔한 잘림 문제입니다
표가 페이지에 맞는가 여덟 열짜리 표는 A4에서 거의 살아남지 못합니다
링크가 의미 있는가 blob 링크와 외부 링크는 오프라인에서도 말이 되어야 합니다
기밀 텍스트를 제거했는가 변환이 로컬이어도 PDF는 전달될 수 있습니다
테마가 독자에게 맞는가 엔지니어링에는 Clean, 고객에게는 Business, 글에는 Academic
페이지 크기가 받는 사람과 맞는가 A4와 Letter는 페이지 나눔을 바꿉니다
파일 이름에 버전이 있는가 결과물을 추적할 수 있게 합니다

테마 치트 시트

  • Clean — 명세서, 기술 README, 코드가 많은 유인물, 감사.
  • Business — 고객 전달 문서, 제안서, 워크숍 자료, 포트폴리오 첨부.
  • Academic — 강의 패킷, 논문, 장문의 글, 연구 지원.
  • Dark — 내보내기 전 화면 검토. 인쇄 스타일시트가 종이용으로 밝게 바꿉니다.

확신이 없다면 Clean으로 시작해 한 부를 내보내고 휴대폰이나 인쇄된 페이지에서 읽어 보세요. 큰 모니터에서 가장 좋아 보인 테마가 팔 길이 거리에서 가장 잘 읽히는 테마는 아닙니다.

인쇄 설정과 문제 해결을 포함한 전체 흐름은 GitHub README를 PDF로 변환하는 방법에서, 네 가지 테마를 더 자세히 보려면 Clean vs Business vs Academic vs Dark에서 확인하세요.

나만의 README PDF 만들기

무료이고 로그인이 필요 없으며, 모든 처리가 클라이언트에서 이루어집니다.

변환기 열기