GitHub 오픈소스 탐험

Markdown 파일을 작성하다 보면, 결과물이 어떻게 보일지 궁금할 때가 많습니다. 특히 긴 문서나 복잡한 내용이 포함된 파일이라면 마크다운이 제대로 렌더링되고 있는지 확인하는 것이 중요합니다. 이런 상황에서 사용자에게 빠르고 직관적인 경험을 제공하는 것이 바로 Markdown Preview입니다. 이 프로젝트는 macOS에서 손쉽게 Markdown 파일을 미리 볼 수 있도록 도와줍니다.

Markdown Preview란?

Markdown Preview는 macOS를 위한 간단하고 빠른 Markdown 뷰어입니다. 이 앱은 Electron이나 브라우저 탭을 사용하지 않고, 네이티브 환경에서 Markdown 파일을 쉽게 열어볼 수 있게 해줍니다. 오픈소스 프로젝트인 만큼, 여러 개발자들이 함께 참여하여 지속적으로 발전하고 있습니다. 현재 1,323개의 스타를 기록하며 많은 사용자들에게 사랑받고 있습니다.

주요 기능

Markdown Preview는 다음과 같은 핵심 기능들을 제공합니다:

네이티브 렌더링: WKWebView를 사용하여 마크다운 파일을 빠르게 렌더링합니다. 링크 처리와 헤딩 앵커 기능도 지원합니다.
편집 모드: 마크다운 파일을 직접 수정할 수 있는 기능을 제공합니다. 포맷팅 툴바를 통해 제목, 강조, 리스트, 인용, 코드, 링크 등을 쉽게 추가할 수 있습니다. 편집 모드는 툴바에서 토글하거나 ⌘E 단축키를 사용하여 활성화할 수 있습니다.
Mermaid 다이어그램 지원: mermaid 코드 블록을 사용하여 다이어그램을 그릴 수 있습니다. 이 기능은 오프라인에서도 작동합니다.
수학 공식을 위한 LaTeX 지원: LaTeX를 사용하여 수학 공식을 작성하고, 이를 미리 볼 수 있습니다.
문서 개요: 사이드바에서 문서의 목차를 보여주며, 클릭하여 해당 섹션으로 바로 이동할 수 있습니다.
직관적인 검색 기능: 문서 내에서 검색이 가능하며, 표준 단축키인 ⌘F로 쉽게 검색할 수 있습니다.
다양한 텍스트 편집기와의 호환성: VS Code, Sublime Text 등 다양한 텍스트 편집기와 연결하여 바로 열 수 있습니다.

설치 및 사용법

Markdown Preview는 Homebrew를 통해 설치할 수 있습니다. 아래의 명령어를 터미널에 입력해 보세요:

brew install --cask markdown-preview

또는 Releases 페이지에서 최신 DMG 파일을 다운로드하여 설치할 수 있습니다.

설치가 완료되면, .md 파일을 아이콘 위로 드래그하거나 Markdown Preview를 기본 핸들러로 설정해 보세요. 그러면 깔끔하고 스크롤 가능한 미리보기가 표시됩니다.

기본 사용 예제

Markdown Preview의 사용법은 매우 간단합니다. Markdown 파일을 열면 아래와 같은 인터페이스가 나타납니다.

Markdown 파일 열기: Finder에서 .md 파일을 선택한 후, 스페이스바를 눌러 Quick Look 기능으로 미리 볼 수 있습니다.
편집 모드 활성화: ⌘E를 눌러 편집 모드를 활성화합니다. 포맷팅 툴바를 사용하여 내용을 수정할 수 있습니다.
수학 공식 추가: 다음과 같은 형식으로 수학 공식을 추가할 수 있습니다:

   $$E = mc^2$$

다이어그램 추가: Mermaid 다이어그램을 추가해 보세요:

mermaid

graph TD; A-->B; A-->C; B-->D; C-->D;

실무에서의 활용 시나리오

Markdown Preview는 기술 문서, 블로그 포스트, 업무 보고서 등 다양한 문서 작업에 유용합니다. 예를 들어, 개발자가 API 문서를 작성할 때, Markdown Preview를 사용하여 실시간으로 결과물을 확인하며 수정할 수 있습니다. 또한, 팀원과의 협업 시, 작성된 문서를 Markdown Preview로 미리보기를 통해 쉽게 공유할 수 있습니다.

유사 도구와의 비교

비슷한 도구로는 Typora, Obsidian, 마크다운 에디터와 같은 다양한 텍스트 편집기가 있습니다. 하지만 Markdown Preview는 특히 macOS에 최적화되어 있어 빠른 성능과 직관적인 UI를 제공합니다. 또한, Electron 기반 앱들보다 훨씬 가볍고 반응성이 뛰어난 것이 큰 장점입니다.

빠르고 깔끔한 Markdown 파일 뷰어, Markdown Preview로 Markdown 문제 해결하기