PreviewMD Mac, iPad, iPhone용
받기

PreviewMD가 렌더링하는 것, 그리고 그것을 렌더링하는 것

아래의 렌더러는 모두 앱 안에 함께 담겨 있습니다. 문서를 그리는 동안 받아오는 것이 없고, CDN에 접속하지 않으며, 사용 기록이 기기를 떠나지도 않습니다. 그래서 훑어보기가 곧바로 뜨고, 이 모든 것이 비행기 안에서도 작동합니다.

이 페이지도 같은 구성으로 렌더링됩니다. 위쪽의 소스로 전환하면 이 페이지의 어떤 예시든 그 뒤에 있는 마크다운을 볼 수 있습니다.

모듈

모듈 버전 하는 일
markdown-it 14.1.0 파서. CommonMark와 아래의 GitHub 확장
KaTeX 0.16.22 수식을 그림이 아니라 조판으로
Mermaid 11.16.1 텍스트에서 그려지는 다이어그램
highlight.js 11.11.1 구문 강조, 약 200개 언어
@vscode/markdown-it-katex 1.1.2 본문의 $…$와 $$…$$를 찾아 KaTeX에 넘김
markdown-it-task-lists 2.1.0 - [x] 체크박스
markdown-it-footnote 4.0.0 각주와 되돌아가는 링크
markdown-it-emoji 2.0.2 :shortcodes:
markdown-it-front-matter 0.2.4 YAML 머리말. 찍어 내지 않고 숨김
jsdiff + diff2html — 비교 보기와 그 단어 단위 강조
github-markdown-css — 페이지 스타일, 밝은 모드와 어두운 모드

각 모듈은 자체 라이선스 고지를 지니고 있으며, 앱의 도움말 ▸ 감사의 말에 원문 그대로 실려 있습니다.

수식

KaTeX는 수식을 조판하므로, 수식이 흐릿한 그림으로 도착하는 대신 크기를 키워도 깨지지 않고 텍스트로 선택하고 복사할 수 있습니다. 줄 안의 수식은 달러 기호 하나로 감쌉니다. 예컨대 궤도상 임의의 점에서의 속도는 v=μ(2/r−1/a)v = \sqrt{\mu(2/r - 1/a)} 입니다. 한 줄을 혼자 차지하는 수식은 달러 기호 두 개로 감쌉니다.

Δv=μr1(2r2r1+r2−1)\Delta v = \sqrt{\frac{\mu}{r_1}}\left(\sqrt{\frac{2r_2}{r_1+r_2}} - 1\right)

행렬과 합, 정렬된 수식도 같은 방식으로 됩니다.

A=(abcd)∑n=1∞1n2=π26A = \begin{pmatrix} a & b \\ c & d \end{pmatrix} \qquad \sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}

다이어그램

mermaid라고 표시한 블록은 그림이 됩니다. 기준이 되는 것은 여전히 텍스트입니다. 한 줄을 고치면 그림이 바뀌고, 그래도 파일은 버전 관리가 차이를 낼 수 있는 텍스트 파일로 남습니다.

graph LR
  A[쓰기] --> B[미리보기]
  B --> C{괜찮은가?}
  C -- 예 --> D[내보내기]
  C -- 아니오 --> A

주고받는 일이 있는 것에는 시퀀스 다이어그램입니다.

sequenceDiagram
  participant F as Finder
  participant Q as 훑어보기
  participant P as PreviewMD
  F->>Q: README.md에서 스페이스바
  Q->>P: 이 파일을 렌더링해 달라
  P-->>Q: 렌더링된 페이지
  Q-->>F: 표시됨, 앱은 실행되지 않음

그리고 표로 적으면 독자가 직접 계산해야 하는 비율에는 원형 차트입니다.

pie showData
  title README는 무엇으로 이루어지는가
  "글" : 55
  "코드 블록" : 30
  "표" : 10
  "다이어그램" : 5

상태 다이어그램과 클래스 다이어그램, 간트 차트, 그 밖에 Mermaid가 가진 나머지도 같은 방식으로 렌더링됩니다.

코드

블록은 highlight.js가 강조하며, 약 200개 언어를 압니다. 언어 이름은 여는 표시 뒤에 적습니다.

struct Entry: Comparable {
    let clock: UInt64
    let device: UUID

    static func < (a: Entry, b: Entry) -> Bool {
        // 동점은 기기 ID로 가리므로 순서는 어디서나 같다.
        (a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
    }
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
    """원 궤도 사이 전이에 필요한 전체 델타 V."""
    first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
    second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
    return first + second

언어를 적지 않은 블록은 고정폭 일반 텍스트로 남고, inline code에는 언어가 전혀 필요하지 않습니다.

GitHub 확장

GitHub이 마크다운에 더한 것, 따라서 README가 있다고 전제하는 것들입니다.

  • 작업 목록, 상자까지 그려서
  • 아직 끝나지 않은 것도 포함해서
  • 더 이상 해당되지 않는 것에는 취소선
  • 각주[1], 번호가 붙고 되돌아가는 링크까지
  • 자동 링크: https://previewmd.xfanta.com 는 그 자체로 링크가 됩니다
  • 쇼트코드로 쓰는 이모지: 🚀 ✨ ✅

Note

알림 블록은 GitHub 자체의 관습이고 어떤 마크다운 명세에도 들어 있지 않습니다. 첫 줄에 종류를 적은 인용 블록입니다.

Warning

종류는 다섯 가지입니다. Note, Tip, Important, Warning, Caution.


  1. 문서 맨 아래에 놓이고, 읽던 자리로 돌아가는 화살표가 붙습니다. ↩︎

조용한 기능들

머리말. 파일 맨 위, --- 줄 사이에 놓인 YAML 블록은 정적 사이트 생성기를 위한 메타데이터이고, 읽히려고 쓴 것이 아닙니다. 알 수 없는 글자의 표로 찍어 내는 대신 해석해서 숨깁니다.

이미지. 문서가 가리키는 로컬 이미지는 그 문서가 놓인 폴더에서 불러와 보여 줍니다. 네트워크로 받아오는 것이 없으므로, 경로가 끊긴 문서는 멈춰 있지 않고 그렇다고 알려 줍니다.

표. 평범한 GFM 파이프 표이고, 정렬은 구분 줄의 콜론에서 읽어 옵니다. 넓은 표는 페이지를 망가뜨리는 대신 옆으로 스크롤됩니다.

이 모든 것을 내 Mac에서 읽기

PreviewMD는 이 페이지에 있는 모든 것을 훑어보기에서도, 자체 창에서도, 내보낸 HTML과 PDF에서도 렌더링합니다. Mac과 iPad, iPhone에서 무료입니다.

치트시트에는 모든 기호와 그 결과가 정리되어 있고, 마크다운이란 무엇인가는 이 형식이 어디에서 왔는지를 다룹니다.