Markdown Viewer

**실시간 미리보기를 제공하는 로컬 우선 Markdown 편집기 및 뷰어** 브라우저, 프로그레시브 웹 앱(PWA), Docker 또는 Neutralino 데스크톱 애플리케이션에서 Markdown을 열고 작성하고 정리하고 검토하고 렌더링하고 내보낼 수 있습니다. 필요한 경우 공유와 공동 편집도 사용할 수 있습니다. [![라이선스](https://img.shields.io/github/license/ThisIs-Developer/Markdown-Viewer?style=flat-square&color=red)](../LICENSE) [![최신 릴리스](https://img.shields.io/github/v/release/ThisIs-Developer/Markdown-Viewer?style=flat-square&color=FF6B00)](https://github.com/ThisIs-Developer/Markdown-Viewer/releases)

[English](../README.md) · [日本語](README_ja.md) · **한국어** · [简体中文](README_zh.md) · [繁體中文](README_tw.md) [웹 앱 열기](https://markdownviewer.pages.dev/) · [문서(영어)](../wiki/Home.md) · [이슈 보고](https://github.com/ThisIs-Developer/Markdown-Viewer/issues) · [릴리스](https://github.com/ThisIs-Developer/Markdown-Viewer/releases)

목차(클릭하여 펼치기)

- [Markdown Viewer 소개](#markdown-viewer-소개) - [주요 기능](#주요-기능) - [빠른 시작](#빠른-시작) - [로컬 처리와 네트워크 처리](#로컬-처리와-네트워크-처리) - [미디어 저장 방식](#미디어-저장-방식) - [주요 제한](#주요-제한) - [개인정보 관련 중요 사항](#개인정보-관련-중요-사항) - [문서](#문서) - [쇼케이스 프로젝트](#쇼케이스-프로젝트) - [개발 여정](#개발-여정) - [기여자](#기여자) - [기여 및 라이선스](#기여-및-라이선스)

## Markdown Viewer 소개 Markdown Viewer는 개발자, 작성자, 학생, 연구자 등 `.md` 또는 `.markdown` 파일을 사용하는 모든 사람을 위한 오픈 소스 로컬 우선 작업공간입니다. 단순한 텍스트를 넘어 여러 문서를 정리하고, Markdown을 변경하지 않은 채 댓글과 제안으로 검토하며, 다이어그램, 지도, 차트, 수식, 3D 모델, 음악을 하나의 집중된 작업공간에서 렌더링할 수 있습니다. 문서를 Share Snapshot 링크로 만들어 빠르게 공유하거나, 접근 권한이 제어되는 Live Share에서 실시간 공동 편집, 라이브 커서, 댓글, 제안을 사용할 수 있습니다. 일상적인 편집은 기기에서 처리됩니다. 계정이 필요 없으며 애플리케이션에는 광고, 분석, 원격 측정 또는 구독이 없습니다.

Markdown Viewer 애플리케이션 화면

## 주요 기능 - **작업공간 및 문서:** 앱의 문서 수 제한 없이 중첩 폴더에서 문서를 정리할 수 있습니다. 실제 한도는 사용 가능한 저장 공간입니다. 최근 파일, 즐겨찾기, 검색, 탭, 일괄 작업, 암호화된 Secret Workspace(비밀 작업 공간)를 지원합니다. - **백업 및 복원:** 폴더 구조를 유지하는 작업공간 ZIP을 내보내거나 가져올 수 있습니다. 암호화된 Secret Workspace 파일은 선택적으로 포함할 수 있지만 휴지통과 데스크톱 기록은 백업에 포함되지 않습니다. - **편집 및 리뷰:** 편집기, 분할 보기, 미리보기 사이를 전환할 수 있습니다. 서식 도구, 사용자 지정 실행 취소/다시 실행, 찾기 및 바꾸기, LTR/RTL, 댓글과 제안을 사용할 수 있습니다. - **Markdown 렌더링:** CommonMark 스타일의 기본 구문, GitHub-Flavored Markdown(GFM), 표, 작업 목록, 알림, 각주, 정의 목록, 코드 구문 강조, 정제된 HTML, MathJax를 지원합니다. - **시각 콘텐츠:** Mermaid, PlantUML, Graphviz/DOT, D2, Vega-Lite, WaveDrom, Markmap, GeoJSON, TopoJSON, STL, ABC 기보를 렌더링합니다.

다이어그램 삽입 모듈 다이어그램 렌더링 예시 3D STL 보기 전체 화면 3D STL 보기

- **가져오기 및 내보내기:** 로컬 파일이나 공개 GitHub 콘텐츠를 열고 Markdown, 독립 실행형 HTML, PNG, 브라우저 인쇄/PDF 저장, 레거시 래스터 PDF로 내보낼 수 있습니다. - **선택적 공유:** 보기 전용 또는 편집 가능 모드의 Share Snapshot(스냅샷 공유)을 만들거나, 호스트/편집 가능/보기 전용 권한을 사용하는 임시 Live Share(라이브 공유) 방을 시작할 수 있습니다.

Live Share 세션

- **다양한 실행 방식:** 호스팅 웹 앱, PWA, 정적 호스팅, Docker, Cloudflare 또는 Neutralino 데스크톱 애플리케이션을 사용할 수 있습니다. 구현된 동작과 제한은 [기능 참고(영어)](../wiki/Features.md)를 확인하세요. ## 빠른 시작 [호스팅 웹 앱](https://markdownviewer.pages.dev/)을 사용하거나 로컬 HTTP 서버로 저장소를 실행합니다. ```bash git clone https://github.com/ThisIs-Developer/Markdown-Viewer.git cd Markdown-Viewer python -m http.server 8080 ``` `http://localhost:8080`을 여세요. `file://`에서는 브라우저 보안 정책이 Web Worker와 Service Worker를 차단할 수 있습니다. | 실행 대상 | 자세한 문서(영어) | | :--- | :--- | | PWA/정적 웹 호스팅 | [설치](../wiki/Installation.md) | | Docker | [Docker 배포](../wiki/Docker-Deployment.md) | | Cloudflare Pages/KV/Durable Objects | [설정](../wiki/Configuration.md) | | Neutralino 데스크톱 애플리케이션 | [데스크톱 애플리케이션](../wiki/Desktop-App.md) | ## 로컬 처리와 네트워크 처리 Markdown Viewer는 로컬 우선 애플리케이션이지만 모든 기능이 오프라인으로 작동하는 것은 아닙니다. | 작업 | 기본 데이터 경로 | | :--- | :--- | | 편집, 로컬 가져오기, 미리보기, 작업공간 자동 저장, 대부분의 내보내기 | 기기 | | 웹 라이브러리 및 캐시되지 않은 렌더러 의존성 | 웹/PWA 빌드에서 CDN 요청 | | GitHub 가져오기 및 이모지 조회 | GitHub API/원시 콘텐츠 호스트 | | PlantUML, D2, Graphviz, Vega-Lite, WaveDrom, 일부 다이어그램 미리보기 | 다이어그램 소스가 PlantUML, Kroki 또는 mermaid.ink로 전송될 수 있음 | | 동의 후 삽입하는 이미지, GIF, 동영상 | 공개 링크 방식의 Cloudflare 임시 미디어 저장소(90일) | | 큰 Share Snapshot | Cloudflare KV(90일) | | Live Share | Cloudflare Durable Object WebSocket 릴레이 | | 외부 이미지, 미디어, 링크, 지도 타일 | 문서에서 지정한 외부 호스트 | Share Snapshot 및 Live Share URL은 베어러 링크입니다. 유효한 링크를 가진 사람은 링크에 포함된 권한을 사용할 수 있습니다. Live Share는 종단 간 암호화를 제공하지 않습니다. 민감한 문서에 네트워크 기능을 사용하기 전에 [개인정보 및 보안(영어)](../wiki/Privacy-and-Security.md)을 확인하세요. ## 미디어 저장 방식 - AVIF, BMP, GIF(애니메이션 GIF 포함), JPEG, PNG, WebP, MP4, WebM, Ogg를 삽입할 수 있습니다. - 처음 동의한 후 미디어는 Cloudflare 임시 저장소에 업로드되고 짧은 콘텐츠 주소형 HTTPS URL로 삽입됩니다. - URL을 아는 사람은 만료 전까지 미디어를 가져올 수 있습니다. - 같은 콘텐츠를 마지막으로 업로드한 시점부터 90일 후 만료됩니다. - Share Snapshot과 Live Share는 Markdown 안의 URL을 공유할 뿐 별도의 미디어 복사본을 만들지 않습니다. ## 주요 제한 - Markdown Viewer는 문서 수 제한을 두지 않습니다. 실제 한도는 브라우저 할당량 또는 데스크톱 파일 시스템 용량입니다. - 로컬 Markdown 파일 하나의 최대 크기는 10 MB입니다. - GitHub 가져오기는 저장소/폴더 결과에서 Markdown 파일을 최대 30개까지 표시합니다. - 처리 전 미디어 원본은 25 MiB까지입니다. 저장 한도는 정지 이미지 300 KiB, GIF 5 MiB, 동영상 10 MiB입니다. - 저장형 Share Snapshot은 최대 8,000,000자이며 90일 후 만료됩니다. - Live Share는 WebSocket 참가자 최대 64명, 실시간 메시지당 8 MB까지 지원합니다. - STL은 소스 2 MiB, 렌더링 지오메트리 300,000개 정점으로 제한됩니다. - 래스터 PDF/PNG는 브라우저 메모리, Canvas, CORS 제한의 영향을 받습니다. ## 개인정보 관련 중요 사항 - 일반 웹 문서는 문서별 IndexedDB 레코드에 저장되고, 데스크톱 문서는 고정된 `Documents/Markdown Viewer Vault`에 저장됩니다. - 프라이빗 모드를 켜면 해당 세션의 새 문서 상태 저장이 중지됩니다. 기존 일반 문서와 Secret Workspace 데이터는 삭제되지 않습니다. - **작업공간 재설정**은 문서, 폴더, 설정, 리뷰 데이터, Secret Workspace 데이터, 기록 및 휴지통을 영구적으로 삭제합니다. - **저장 및 백업**에서 폴더 구조를 유지하는 ZIP을 만들거나 가져올 수 있습니다. 백업을 가져오면 확인 후 현재 작업공간이 완전히 대체됩니다. - Live Share는 Markdown/리뷰 콘텐츠를 서버에 영구 저장하지 않습니다. 다만 역할별 베어러 권한 값과 생성 시각은 Durable Object 저장소에 보관되며, 애플리케이션 수준의 만료 시간이나 삭제 경로가 없습니다. - Share Snapshot 생성 API는 삭제 토큰을 반환하지만 현재 UI는 해당 토큰을 표시하거나 만료 전 삭제 작업을 제공하지 않습니다. - 애플리케이션 코드에는 계정, 분석, 원격 측정, 광고, 추적 픽셀 또는 앱 전용 쿠키가 구현되어 있지 않습니다. 외부 서비스나 호스팅 제공자는 일반 요청 로그를 처리할 수 있습니다. > **백업:** **작업공간 재설정**은 모든 로컬 작업공간 데이터를 영구적으로 삭제합니다. 보관할 데이터가 있다면 먼저 **저장 및 백업**에서 ZIP 백업을 만드세요. ## 문서 상세 페이지는 영어로 유지 관리됩니다. | 목적 | 페이지(영어) | | :--- | :--- | | 전체 기능과 제한 | [Features](../wiki/Features.md) | | 일상 사용법과 단축키 | [Usage Guide](../wiki/Usage-Guide.md) | | Markdown/다이어그램 구문 | [Markdown Reference](../wiki/Markdown-Reference.md) | | Share Snapshot | [Share Snapshot](../wiki/Share-Snapshot.md) | | Live Share | [Live Share](../wiki/Live-Share-Cloudflare.md) | | 개인정보 및 보안 | [Privacy and Security](../wiki/Privacy-and-Security.md) | | 설치 및 배포 | [Installation](../wiki/Installation.md) | | 문제 해결 | [Troubleshooting](../wiki/Troubleshooting.md)/[FAQ](../wiki/FAQ.md) | | 기여 | [Contributing](../wiki/Contributing.md) | | 다국어 용어 및 현지화 | [Localization and Terminology](../wiki/Localization.md) | ## 쇼케이스 프로젝트 Markdown Viewer를 활용한 다음 커뮤니티 프로젝트는 해당 개발자가 독립적으로 유지 관리합니다. - [**Markdown Desk**](https://github.com/jhrepo/markdown-desk): Tauri로 만든 네이티브 macOS 래퍼입니다. 네이티브 파일 대화 상자와 파일 핸들러, 메뉴 막대 통합, 자동 다시 불러오기 및 앱 내 업데이트 기능을 추가합니다. ## 개발 여정 Markdown Viewer는 PC에서 시작한 작은 개인 프로젝트였습니다. 호기심에서 출발해 실수와 수정을 거치고 많은 정성을 담아 만든 단순한 Markdown 뷰어입니다. 초기 버전은 지금도 온라인에서 사용할 수 있으며 프로젝트의 중심으로 남아 있습니다. 더 자세한 역사는 [Development Journey(영어)](../wiki/Development-Journey.md)를 참조하세요. ## 기여자 Markdown Viewer는 커뮤니티의 기여를 통해 성장하고 있습니다.

Markdown Viewer 기여자

## 기여 및 라이선스 Pull Request를 만들기 전에 [Contributing(영어)](../wiki/Contributing.md)을 읽어 주세요. 재현 가능한 버그와 구체적인 기능 제안은 [이슈 추적기](https://github.com/ThisIs-Developer/Markdown-Viewer/issues)에 등록할 수 있습니다. 취약점 세부 정보는 일반 이슈에 게시하지 마세요. Markdown Viewer는 [Apache License 2.0](../LICENSE)에 따라 제공됩니다.