Quick Syntax

문장 안 수식은 $E = mc^2$처럼 작성합니다.

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

```math
\sqrt{3x - 1} + (1 + x)^2
```

$..., $...$, mathcode fence는 Markdown 표준이 아니라 GitHub나 수식 plugin의 renderer 기능입니다. 수식은 짧으면 inline, 독립 계산식이면 block으로 나누고, ``$...,$...$, math` code fence는 Markdown 표준이 아니라 GitHub나 수식 plugin의 renderer 기능입니다. 수식은 짧으면 inline, 독립 계산식이면 block으로 나누고, 가 가격·shell·template 문자일 때는 현재 renderer가 권장하는 escape 또는 대체 표기를 실제 preview에서 확인합니다.

작성 방식

inline 수식은 문장 안에서 짧게 쓴다

GitHub Markdown에서는 $...GitHub Markdown에서는 로 감싼 식을 inline math로 렌더링할 수 있습니다. 문장 흐름 안에서 변수, 짧은 공식, 단위 변환을 보여 줄 때 적합합니다. 수식 안의 문자가 Markdown 문법과 겹치면 GitHub Markdown에서는 `$...GitHub Markdown에서는 로 감싼 식을 inline math로 렌더링할 수 있습니다. 문장 흐름 안에서 변수, 짧은 공식, 단위 변환을 보여 줄 때 적합합니다. 수식 안의 문자가 Markdown 문법과 겹치면 와 backtick을 조합한 형태를 사용할 수 있습니다.

원 둘레는 $2\pi r$입니다.

복잡한 문자가 섞이면 $`\sqrt{3x-1}+(1+x)^2`$ 형태를 씁니다.

긴 식을 inline으로 억지로 넣으면 모바일 폭에서 읽기 어렵고 줄바꿈도 예측하기 어렵습니다. 한 줄을 넘는 식은 block 수식으로 분리하는 편이 좋습니다.

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, 템플릿 변수처럼 문장 안의 가격, shell prompt, 템플릿 변수처럼 자체를 보여 줘야 하는 경우에는 수식 구분자와 충돌할 수 있습니다. 수식 안에서 literal dollar를 쓰려면 \문장 안의 가격, shell prompt, 템플릿 변수처럼 문장 안의 가격, shell prompt, 템플릿 변수처럼 자체를 보여 줘야 하는 경우에는 수식 구분자와 충돌할 수 있습니다. 수식 안에서 literal dollar를 쓰려면 처럼 escape하고, 수식 밖 같은 줄에서 가격을 보여 줄 때는 <span>$</span>` 같은 방법으로 구분하는 것이 안전합니다.

가격은 <span>$</span>100이고, 절반은 $100 / 2$입니다.

수식 안 dollar는 $`\sqrt{\$4}`$처럼 escape합니다.

선택 기준

주의사항