프로젝트 소개

markdown-viewer(바이너리 이름 `mdv`)는 단일 바이너리로 배포되는 로컬 Markdown 뷰어 및 파일 브라우저입니다. 로컬 HTTP 주소를 통해 Markdown 파일 디렉터리를 제공하고, 왼쪽에는 확장 가능한 지속적 파일 트리, 오른쪽에는 렌더링된 콘텐츠를 배치한 2분할 인터페이스를 제공합니다. 렌더링은 GitHub 스타일의 GitHub Flavored Markdown, 구문 강조 코드 블록, 번들로 포함된 Mermaid 다이어그램 지원을 포함합니다. CSS, JavaScript, HTML 템플릿 등 모든 UI 자산이 바이너리에 내장되어 있어 외부 의존성이나 별도 설치 단계가 필요하지 않습니다. 보안 기본값에는 디렉터리 순회 보호와 XSS 방지를 위한 HTML 정리가 포함됩니다. 종료는 UI에서 또는 Ctrl+C로 트리거할 수 있습니다. 설치는 릴리스 페이지에서 대상 플랫폼용 `mdv` 바이너리를 다운로드하고, 아카이브를 추출한 뒤 바이너리를 PATH에 배치하면 됩니다. 구성은 `config.json` 파일 또는 명령줄 플래그로 설정할 수 있으며, 우선순위는 다음과 같습니다(뒤의 항목이 앞의 항목을 덮어씀): 내장 기본값, `$HOME/.config/mdv/config.json`, 현재 작업 디렉터리의 `config.json`, `MDV_` 접두사가 붙은 환경 변수(예: `MDV_PORT=9000`), 마지막으로 명령줄 플래그입니다. 참고용으로 `config.json.example`이 제공됩니다. 사용법은 Markdown 파일이 있는 임의의 디렉터리에서 `mdv`를 실행하고 브라우저에서 `http://127.0.0.1:8080`을 여는 것입니다. 플래그로는 `-p, --port`(기본값 8080), 브라우저를 자동으로 실행하는 `-o, --open`, 제공할 루트 디렉터리를 설정하는 `-d, --dir`(기본값 `.`), `--version`이 있습니다. 소스에서 빌드하려면 Go 1.24 이상이 필요합니다. Make 대상으로는 현재 플랫폼용 `build`, 크로스 컴파일용 `build-all`, zip 아카이브를 생성하는 `package`, `test`, `clean`이 있습니다. 대상 플랫폼은 linux/amd64, linux/arm64, darwin/arm64, windows/amd64이며, macOS 빌드는 arm64 전용이고 Intel Mac은 소스에서 빌드할 수 있습니다. 저장소에는 CHANGELOG.md와 서드파티 라이선스 명시가 담긴 NOTICE.md도 포함되어 있습니다.