Quick Syntax
`git status`
\*별표\*를 문자 그대로 보여 주기
``code with `backtick` inside``명령어·경로·식별자는 inline code로, Markdown 기호를 일반 문자로 보일 때는 backslash escape로 분리합니다. code span 안에 backtick이 있으면 바깥 delimiter를 더 길게 쓰고, code span 안에서 backslash escape가 문법을 바꿀 것이라고 기대하지 않습니다.
문법
인라인 코드는 본문 속 리터럴을 구분하는 의미 신호다
인라인 코드(`backtick`)는 명령어, 파일명, 변수명, 옵션, 경로처럼 "이것은 컴퓨터가 해석하는 정확한 문자열이다"라는 의미를 전달한다. 단순히 강조나 모노스페이스 폰트가 필요해서 쓰는 것이 아니라, 리터럴 값임을 독자에게 알리는 목적이 핵심이다. 코드가 아닌 내용에 backtick을 남용하면 독자가 실제 실행 가능한 명령어와 일반 설명을 구분하기 어려워진다.
`npm run build`를 실행한 뒤 `dist/` 폴더를 확인합니다.
환경 변수 `NODE_ENV`를 `production`으로 설정합니다.code span 안에 backtick이 있을 때는 더 긴 delimiter로 감싼다
backtick 하나로 감싸는 것이 기본이지만, 코드 안에 backtick이 포함되면 닫는 backtick이 어디인지 파서가 혼동한다. 이때는 감싸는 backtick 개수를 늘리면 된다. 두 개의 backtick으로 시작하고 끝낸 code span 안에서는 단일 backtick이 문자 그대로 인식된다. 몇 개든 원하는 수를 사용할 수 있지만, 시작과 끝의 개수는 같아야 한다.
`` `git status` `` <!-- 단일 backtick을 코드로 포함 -->
``` ``nested`` ``` <!-- 이중 backtick을 코드로 포함 -->backslash escape는 code span 바깥 일반 텍스트에서 해석된다
\*, \#, \[, \| 처럼 backslash 앞에 붙이면 Markdown 기호를 문자 그대로 출력할 수 있다. CommonMark에서 backtick으로 감싼 code span 안의 backslash escape는 해석되지 않고 문자 그대로 남는다. 탈출이 필요한 상황이라면 code span 바깥에서 escape하거나, code span을 더 긴 backtick delimiter로 감싸는 방식을 선택한다.
<!-- 일반 텍스트에서 escape: 동작함 -->
문장 안에서 \# 해시는 제목이 아니라 문자로 보입니다.
\*별표\*도 강조가 아닌 문자로 표시됩니다.
<!-- code span 안에서는 backslash가 그대로 보임 -->
`\*`escape 가능한 문자 목록은 CommonMark 표준으로 정해져 있다
CommonMark는 \ 뒤에 올 수 있는 이스케이프 가능 문자를 다음으로 정의한다: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~. 이 목록에 없는 문자 앞의 backslash는 문자 그대로 backslash로 출력된다. 표 안에서 pipe(|)를 포함하려면 \|로 escape하는 것이 대표적인 실무 사례다.
또 하나 자주 섞이는 선택은 "이걸 코드로 감쌀까, escape할까"다. 명령어·파일명·옵션처럼 리터럴이면 인라인 코드가 맞고, 별표나 해시를 그냥 문자로 보여 주는 목적이면 escape가 맞다.
표 셀 안에서 A \| B 처럼 pipe 문자를 표시합니다.
경로 구분자 `\\` 로 윈도우 경로를 나타냅니다.선택 기준
| 상황 | 적합한 선택 |
|---|---|
| 명령어·파일명·변수명 표시 | `인라인 코드` |
| 코드 안에 backtick 포함 | `` 로 감싸기 |
| Markdown 기호를 문자로 표시 | \ 앞에 붙이기 (일반 텍스트에서) |
| 표 셀 안의 pipe 문자 | | |
| code span 안에서 backtick 표시 | 더 긴 backtick delimiter로 전환 |
| 리터럴 값인지 단순 기호인지 애매할 때 | 리터럴이면 코드, 기호면 escape |
주의할 점
code span 안에서는 backslash escape가 해석되지 않습니다. backtick이 포함된 예시는 감싸는 backtick 개수를 늘려 해결하는 편이 더 자연스럽습니다. 인라인 코드는 리터럴 값임을 알리는 의미 신호이므로, 단순 강조 목적으로는 사용하지 않는 것이 좋습니다.
\`git status\`이 표현은 backtick 문자를 보여 주는 데는 맞지만, 명령어 자체를 인라인 코드로 보여 주는 방식은 아닙니다. "리터럴 값"을 드러내고 싶다면 `git status` 가 더 적절합니다.
참고 링크
2 sources