Markdown Buddy › Xcode에서 Markdown 미리보기

Xcode에서 Markdown 미리보기

Xcode는 Markdown 파일을 그대로의 소스로 보여줍니다. README, CHANGELOG, 아키텍처 메모에서는 문서가 아니라 마크업을 읽게 된다는 뜻입니다. Markdown Buddy는 네이티브 Source Editor 확장 프로그램을 제공합니다. Editor 메뉴에서 지금 보고 있는 파일이 렌더링된 상태로 열리고, 프로젝트를 벗어날 필요가 없습니다.

확장 프로그램 설치

1. Mac App Store에서 Markdown Buddy를 설치하고 한 번 실행해, macOS가 함께 들어 있는 확장 프로그램을 등록하게 하세요.
2. 시스템 설정을 열고 일반, 이어서 로그인 항목 및 확장 프로그램으로 가서, Xcode Source Editor 아래의 Markdown Buddy를 켜세요.
3. Xcode를 다시 실행하세요. 확장 프로그램은 시작할 때 읽히므로, 이미 실행 중인 Xcode는 방금 켠 것을 인식하지 못합니다.
4. .md 파일을 열고 Editor 메뉴에서 Markdown Buddy를 선택하세요. Xcode 설정의 Key Bindings에서 단축키를 지정할 수 있습니다.

저장소에서 중요한 이유

프로젝트 문서는 코드 옆에 있는데, 정작 그것을 가장 못 보여주는 것이 코드 편집기입니다.

• 표와 배지가 들어간 README는 그대로의 소스로는 읽을 수 없습니다
• CHANGELOG는 긴 중첩 목록이고, 들여쓰기가 의미를 담고 있습니다
• 아키텍처 메모에는 Mermaid 다이어그램이 자주 들어가는데, Xcode는 이를 둘러싸인 텍스트로 보여줍니다
• 문서 사이의 상대 링크는 소스 보기에서 따라갈 수 없습니다

확장 프로그램 너머

같은 앱이 폴더 전체를 작업 공간으로 열고, 그 안의 모든 .md 파일을 검색하며, 문서 사이의 링크를 그래프로 그려 끊어진 링크를 짚어 줍니다. 문서가 불어난 저장소에서는 미리보기 자체보다 더 쓸모 있을 때가 많습니다.

Editor 메뉴에 명령이 보이지 않을 때

• 시스템 설정의 일반, 로그인 항목 및 확장 프로그램, Xcode Source Editor 항목에서 켜져 있는지 확인하세요.
• Xcode를 완전히 종료했다가 다시 실행하세요. 확장 프로그램 목록은 시작할 때만 읽힙니다.
• 응용 프로그램 폴더에서 Markdown Buddy를 한 번 실행한 뒤 다시 시도하세요.
• 명령은 맨 앞의 문서가 Markdown 파일일 때만 나타납니다. .swift 파일에서는 감춰집니다.