mdcat

프로그램 소개/무엇인지

mdcat은 Markdown 파일을 터미널에서 렌더링하여 표시하는 명령줄 도구입니다. CommonMark 표준을 따르며, 코드 블록에 구문 하이라이트를 적용하고, 지원하는 터미널에서는 링크와 이미지를 인라인으로 보여줍니다. 이 도구는 Markdown 내용을 빠르게 확인하고자 하는 개발자 및 기술 문서 작업자에게 적합합니다.

주요 기능

기본 Markdown 렌더링

mdcat은 모든 기본 CommonMark 구문을 정확히 렌더링합니다. 제목, 목록, 인용구, 강조 등을 터미널에 적절한 스타일로 표시합니다.

코드 블록 하이라이트

syntect 라이브러리를 사용하여 코드 블록에 구문 하이라이트를 적용합니다. 지원하는 프로그래밍 언어에 따라 적절한 색상으로 코드를 보여줍니다.

링크 및 이미지 인라인 표시

OSC8 링크 프로토콜을 지원하는 터미널에서는 링크를 클릭 가능하게 만들고, iTerm2, WezTerm, kitty 등과 같은 터미널에서는 이미지를 인라인으로 렌더링합니다. SVG 이미지는 resvg를 사용하여 처리됩니다.

제목 점프 마크 (iTerm2 전용)

iTerm2에서는 제목에 점프 마크를 추가하여, 단축키(⇧⌘↓ 및 ⇧⌘↑)로 제목 사이를 빠르게 이동할 수 있습니다.

다운로드·설치 방법

mdcat은 GitHub 릴리스에서 사전 빌드된 바이너리를 제공합니다. Release binaries 페이지에서 다운로드할 수 있으며, 이 바이너리는 GitHub Actions에서 빌드되고 출처 증명서를 제공합니다.

또한 Repology를 통해 다양한 서드 파티 패키지를 확인할 수 있으며, Rust 개발 환경이라면 cargo install mdcat 명령어로 직접 빌드 및 설치할 수 있습니다.

기본 사용법

터미널에서 다음 명령어로 Markdown 파일을 볼 수 있습니다:

mdcat sample.md

도움말을 보려면 mdcat --help를 실행하면 사용 가능한 모든 옵션을 확인할 수 있습니다. man 페이지도 제공되며, mdcat(1) 파일을 통해 자세한 사용법을 확인할 수 있습니다.

mdcat을 mdless 심볼릭 링크 또는 하드 링크로 연결하면, 자동으로 페이지네이션 모드로 작동합니다. 이는 긴 문서를 페이지 단위로 보기 유용합니다.

이런 경우에 유용합니다

터미널에서 작업하면서 Markdown 문서의 내용을 빠르게 확인해야 할 때 유용합니다. 예를 들어, README 파일을 프로젝트 디렉터리에서 바로 열어 내용을 검토하거나, 기술 문서를 편집 중에 미리볼 때 유용합니다. 특히 코드가 포함된 문서에서는 구문 하이라이트 덕분에 가독성이 향상됩니다.

지원 환경·시스템 요구사항

mdcat은 strikethrough formatting과 인라인 링크(OSC8)를 지원하는 터미널에서 가장 잘 작동합니다. 이는 Windows Terminal, KDE Konsole, VTE 기반 터미널(GNOME 터미널 등)과 같은 최신 터미널 에뮬레이터를 포함합니다. 구형 터미널(예: Linux 텍스트 콘솔)에서는 이러한 기능이 제한되어 정상적으로 동작하지 않을 수 있습니다.

최신 버전·업데이트

현재 버전은 1.1.0이며, 저장소는 유지보수 상태가 아닙니다. 유지보수되는 포크는 에서 확인할 수 있습니다.

제한 사항·확인 사항

mdcat은 CommonMark의 각주 확장을 지원하지 않습니다. 또한 테이블 셀 내의 인라인 마크업과 텍스트 줄바꿈을 처리하지 못합니다. 이러한 기능이 필요한 경우 다른 도구를 고려해야 합니다.