숏컷 코드

*기울임*
굵게
*굵은 기울임*
취소선

문법

별표와 밑줄은 동등하지 않다 — 단어 중간에서 동작이 다르다

CommonMark 기준으로 *(별표)와 _(밑줄)은 모두 강조를 표현하지만, 단어 경계 처리 방식이 다르다. 밑줄은 단어 중간에서 강조가 활성화되지 않는다. 예를 들어 some_variable_name에서 _는 강조가 아니라 문자 그대로 인식된다. 코드 관련 기술 문서에서는 변수명·파일명에 밑줄이 자주 등장하기 때문에 강조에는 별표 계열을 쓰는 편이 더 안전하고 예측 가능하다.

<!-- 권장: 별표 계열 -->
핵심 용어를 굵게 표시합니다.
*보조 설명*은 기울임으로 표시합니다.

<!-- 주의: 밑줄은 단어 중간에서 의도대로 동작하지 않을 수 있음 -->
some_long_variable_name  <!-- _ 가 강조가 아닌 문자로 처리됨 -->

~~취소선~~은 GFM 전용 확장이라 CommonMark에서는 보장되지 않는다

취소선은 GitHub Flavored Markdown(GFM)에서 추가된 확장 문법이다. GitHub, GitLab, Discord, Slack 같은 GFM 호환 환경에서는 잘 동작하지만, 표준 CommonMark 렌더러나 pandoc(기본 설정), 일부 정적 사이트 빌더에서는 ~~텍스트~~가 그대로 노출된다. 폐기된 옵션이나 삭제된 기능을 표시할 때 주로 쓰이므로, 이식성이 중요한 문서에서는 "폐기됨", "(deprecated)"처럼 텍스트로 명시하는 것이 더 안전하다.

이미 폐기된 옵션은 old-mode처럼 표시합니다.
<!-- GFM 외 환경에서는 텍스트가 그대로 보일 수 있음 -->

강조는 의미를 전달하는 도구여야 하며 장식 수단으로 쓰면 계층이 무너진다

강조 문법은 "이 정보가 특별히 중요하다"는 의미 신호다. 한 문단에 굵게 처리된 단어가 5개 이상이면 독자는 어디에 집중해야 할지 파악하기 어렵다. 기술 문서에서 굵게는 처음 등장하는 핵심 용어나 행동 지침, 기울임은 UI 레이블이나 외래 개념 표기에 주로 쓰인다. 강조를 많이 쓸수록 핵심 대비가 약해진다는 것을 기억하면 절제 기준이 생긴다.

<!-- 나쁜 예: 강조 과다 -->
설정 파일을 열고 환경 변수를 확인한 뒤 재시작하면 변경사항이 반영됩니다.

<!-- 좋은 예: 핵심 행동만 강조 -->
설정 파일을 열고 환경 변수를 확인한 뒤 재시작하면 변경사항이 반영됩니다.

***굵은 기울임***은 사용 빈도가 낮고 렌더러 간 파싱 차이가 있다

***텍스트***는 굵게+기울임을 동시에 적용하는 문법이지만, 별표와 밑줄을 혼용하거나(**_text_**) 중첩 방식이 다를 때 렌더러마다 결과가 달라질 수 있다. 정말 굵은 기울임이 필요하다면 ***를 통일해서 쓰는 것이 가장 안전하며, 가능하면 HTML <strong><em>텍스트</em></strong> 을 명시적으로 쓰는 방법도 있다.

선택 기준

주의할 점