thiagokokada/gh-gfm-preview

어떤 프로젝트인가요?

핵심 기능

• 01goldmark 확장 기능을 사용해 GFM을 로컬에서 렌더링하므로 오프라인에서도 작동
• 02Mermaid 다이어그램, MathJax, 알림 및 구문 강조 코드 블록 지원
• 03미리 보는 파일이 변경되면 브라우저를 실시간으로 새로고침
• 04파일 경로, 표준 입력 또는 자동 감지된 README 입력 지원
• 05여러 파일을 둘러보고 미리 볼 수 있는 디렉터리 목록 모드
• 06단독 바이너리 또는 GitHub CLI 확장으로 실행

활용 사례

• GitHub에 푸시하기 전에 README나 문서 초안 미리 보기
• 키맵을 사용해 Neovim 같은 편집기에서 Markdown 미리 보기
• 인터넷 연결이 불안정한 컴퓨터에서 Markdown 작성

빠른 시작

1. 1

   GitHub CLI 확장 프로그램으로 설치

   gh extension install thiagokokada/gh-gfm-preview
2. 2

   브라우저에서 Markdown 파일 미리 보기

   gh gfm-preview README.md

사용 전 알아둘 점

• !GeoJSON/TopoJSON 다이어그램과 지도 기능을 사용하려면 인터넷 연결이 필요하며, STL 3D 다이어그램은 지원되지 않습니다.
• !멘션, 이슈 및 풀 리퀘스트 참조 등 GitHub에 의존하는 기능은 사용할 수 없습니다.
• !렌더링은 에뮬레이션이므로 GitHub의 출력과 비슷하지만 완전히 동일하지는 않습니다.

토픽

자주 묻는 질문

gh-gfm-preview은(는) 무엇인가요?

오프라인에서도 GitHub Flavored Markdown을 미리 볼 수 있는 로컬 웹 서버를 실행하는 Go CLI 및 GitHub CLI 확장입니다. gh-gfm-preview는 Markdown 파일을 브라우저에서 렌더링하는 로컬 웹 서버를 실행하며, GitHub에서 보이는 Markdown과 최대한 비슷하게 표시하는 것을 목표로 합니다. 렌더링은 yuin/goldmark와 확장 기능을 사용해 로컬에서 처리하므로, 대부분의 기능을 인터넷 연결 없이 사용할 수 있습니다.

gh-gfm-preview은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

gh-gfm-preview은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

gh-gfm-preview은(는) 아직 유지보수되고 있나요?

6개월 이내 업데이트. gh-gfm-preview의 마지막 커밋은 2026년 7월 24일입니다.

gh-gfm-preview은(는) 어디에 사용할 수 있나요?

GitHub에 푸시하기 전에 README나 문서 초안 미리 보기 키맵을 사용해 Neovim 같은 편집기에서 Markdown 미리 보기 인터넷 연결이 불안정한 컴퓨터에서 Markdown 작성

gh-gfm-preview는 어떻게 설치하나요?

GitHub CLI 확장 프로그램으로 설치: gh extension install thiagokokada/gh-gfm-preview 브라우저에서 Markdown 파일 미리 보기: gh gfm-preview README.md

gh-gfm-preview은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/thiagokokada/gh-gfm-preview