빠른 비교
문장 안 수식은 $E = mc^2$처럼 작성합니다.
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
```math
\sqrt{3x - 1} + (1 + x)^2
```작성 방식
inline 수식은 문장 안에서 짧게 쓴다
GitHub Markdown에서는 $...$로 감싼 식을 inline math로 렌더링할 수 있습니다. 문장 흐름 안에서 변수, 짧은 공식, 단위 변환을 보여 줄 때 적합합니다. 수식 안의 문자가 Markdown 문법과 겹치면 $와 backtick을 조합한 형태를 사용할 수 있습니다.
원 둘레는 $2\pi r$입니다.
복잡한 문자가 섞이면 $`\sqrt{3x-1}+(1+x)^2`$ 형태를 씁니다.긴 식을 inline으로 억지로 넣으면 모바일 폭에서 읽기 어렵고 줄바꿈도 예측하기 어렵습니다. 한 줄을 넘는 식은 block 수식으로 분리하는 편이 좋습니다.
block 수식은 $$ 또는 math code block으로 분리한다
문서 안에서 독립적으로 보여 줄 공식은 새 줄에 $$ 구분자를 두거나, fenced code block의 언어를 math로 지정합니다. math code block은 Markdown 문법과 수식 구분자가 충돌하는 상황에서 특히 읽기 쉽습니다.
$$
\left( \sum_{k=1}^n a_k b_k \right)^2
\leq
\left( \sum_{k=1}^n a_k^2 \right)
\left( \sum_{k=1}^n b_k^2 \right)
$$```math
\left( \sum_{k=1}^n a_k b_k \right)^2
\leq
\left( \sum_{k=1}^n a_k^2 \right)
\left( \sum_{k=1}^n b_k^2 \right)
```달러 기호와 수식 구분자를 분리한다
문장 안의 가격, shell prompt, 템플릿 변수처럼 $ 자체를 보여 줘야 하는 경우에는 수식 구분자와 충돌할 수 있습니다. 수식 안에서 literal dollar를 쓰려면 \$처럼 escape하고, 수식 밖 같은 줄에서 가격을 보여 줄 때는 <span>$</span> 같은 방법으로 구분하는 것이 안전합니다.
가격은 <span>$</span>100이고, 절반은 $100 / 2$입니다.
수식 안 dollar는 $`\sqrt{\$4}`$처럼 escape합니다.선택 기준
| 상황 | 선택 |
|---|---|
| 문장 안 짧은 공식 | $...$ |
| Markdown 기호와 충돌하는 inline 수식 | $ + backtick 조합 |
| 독립된 긴 공식 | $$...$$ |
| 수식 블록을 코드처럼 명확히 분리 | math fenced code block |
가격이나 shell $ 표시 | escape 또는 <span>$</span> |
| GitHub 밖 렌더링 | 수식 지원 여부 확인 |
주의사항
Markdown 수식은 모든 렌더러의 표준 기능이 아닙니다. GitHub에서는 렌더링되더라도 다른 문서 사이트, CMS, PDF 변환기에서는 그대로 텍스트로 남을 수 있습니다.
$가 가격, shell prompt, 템플릿 문법과 섞이면 수식 구분자로 오해될 수 있습니다. 같은 줄에 수식과 dollar 문자를 함께 쓸 때는 escape나 <span>으로 의도를 분리하세요.
참고 링크
1 sources