마크다운 문서 주석 제거 공식과 빌드 타임 주석 스트리핑 규칙

발행수정도구마크다운 HTML 주석 일괄 제거기

목차
  1. 1. 마크다운 HTML 주석을 지우는 정규식 원리
  2. 2. 빌드 과정에 주석 제거를 끼워 넣는 법
  3. 3. 주석을 지울 때 흔히 놓치는 예외
  4. 정리
  5. 자주 묻는 질문

깃허브(GitHub)의 오픈소스 리드미(README.md) 파일을 다듬거나 기술 문서 번역을 공동 작업하다 보면, 외부에 노출하고 싶지 않은 내부 메모나 번역 참고용 문장을 마크다운(Markdown) 주석으로 감추어 기재해 두는 경우가 많습니다.

하지만 최종 배포판(Static Build)을 만들어 배포하거나 일반 독자에게 마크다운 문서를 공개하는 시점에는, 이런 내부용 HTML 주석이 텍스트 소스에 그대로 남아 노출되는 경우가 있습니다. 이 글에서는 마크다운 문서 안의 HTML 주석만 골라 제거하는 정규식 원리와 자주 놓치는 예외를 정리합니다.

1. 마크다운 HTML 주석을 지우는 정규식 원리

마크다운 스펙에서 쓰는 주석 형태는 HTML과 동일한 <!-- 주석 내용 --> 구조입니다. 이 구조만 골라 문서 전체에서 제거하는 정규식은 다음과 같습니다.

/<!--[\s\S]*?-->/g

정규식이 하는 일

  • <!--, --> : 주석의 시작과 끝 경계입니다.
  • [\s\S]*? : 개행 문자(\s)와 비개행 문자(\S)를 모두 포함해, 줄바꿈이 들어간 여러 줄 주석까지 잡아냅니다.
  • 물음표(?)는 비탐욕적(non-greedy) 매칭입니다. 이게 빠지면 문서에 주석이 여러 개 있을 때 첫 번째 주석의 시작부터 마지막 주석의 끝까지를 통째로 지워버리는 오작동이 납니다.

이 정규식을 문자열 치환 함수에 넘기면 주석만 빠진 결과를 얻습니다.

cleanedText = originalText.replace(/<!--[\s\S]*?-->/g, "")

2. 빌드 과정에 주석 제거를 끼워 넣는 법

실무에서는 마크다운을 HTML로 변환하는 빌드 단계에 이 치환을 넣어 자동화합니다.

// Next.js 등 정적 사이트의 마크다운 파이프라인 예시
function markdownLoader(content) {
  // 컴파일 직전에 HTML 주석을 제거해
  // 내부용 문구가 배포 결과물에 남지 않게 합니다.
  const cleanContent = content.replace(/<!--[\s\S]*?-->/g, "");
  return marked.parse(cleanContent);
}

매번 에디터에서 찾기(Ctrl+F)로 주석을 눈으로 확인하며 지우거나, 깃에 올리기 전에 수동으로 검사할 필요는 없습니다. 아래 마크다운 주석 제거기에 원문을 붙여넣으면 같은 정규식으로 주석만 골라 제거한 결과를 바로 복사할 수 있습니다. 지운 자리에 빈 줄이 남는 게 싫으면 "빈 줄 정리" 옵션을 함께 켜면 되고, 몇 개의 주석이 제거됐는지도 화면에 함께 표시됩니다.

마크다운 HTML 주석 일괄 제거기

주석 정리가 필요한 마크다운 문장을 복사해 넣고 일괄 주석 제거 단추를 클릭하여 외부에 안전하게 공유 가능한 깨끗한 배포용 문안을 확보해 보세요.

3. 주석을 지울 때 흔히 놓치는 예외

상황주의할 점
예제 코드 안에 <!-- 문자열이 그대로 들어 있는 경우코드 예제로 보여주려고 적어 둔 <!-- 문자열까지 같이 지워집니다. 코드 블록 영역을 먼저 따로 떼어냈다가 주석 제거 후 되돌려야 합니다.
Jekyll·Astro 등의 프런트매터(문서 맨 위 --- 구간)문서 최상단 YAML 메타데이터도 주석 정규식 범위에 걸릴 수 있어, 줄 단위로 프런트매터 영역을 구분해 제외해야 합니다.
여러 주석이 떨어져 있는 문서비탐욕적(?) 매칭이 빠지면 앞서 설명한 대로 첫 주석부터 마지막 주석까지 통째로 지워집니다.

정리

마크다운 HTML 주석은 /<!--[\s\S]*?-->/g 정규식으로 제거할 수 있습니다. 비탐욕적 매칭을 빼먹지 않아야 여러 주석이 있는 문서에서 중간 본문까지 날아가는 사고를 막을 수 있고, 코드 예제 안의 <!-- 문자열과 프런트매터 영역은 별도로 처리해야 안전합니다. 직접 정규식을 돌리기 번거로우면 도구에 원문을 붙여넣어 바로 결과를 확인할 수 있습니다.

마크다운 HTML 주석 일괄 제거기

주석 정리가 필요한 마크다운 문장을 복사해 넣고 일괄 주석 제거 단추를 클릭하여 외부에 안전하게 공유 가능한 깨끗한 배포용 문안을 확보해 보세요.

자주 묻는 질문

주석 안에 마크다운 문법이 들어 있어도 지워지나요?

네. <!-- --> 사이의 내용은 형식과 무관하게 통째로 제거 대상입니다. 안에 마크다운 문법이나 일반 텍스트가 섞여 있어도 주석 경계(<!--, -->) 기준으로 지워집니다.

HTML 파일에도 같은 정규식을 쓸 수 있나요?

네, HTML 주석 표기가 같으므로 같은 패턴이 그대로 동작합니다. 다만 HTML은 <script>·<style> 태그 안에 비슷한 문자열이 들어갈 수 있어, 마크다운보다 예외를 한 번 더 확인하는 편이 안전합니다.

관련 글

  1. 이력서 액션 버브 작성 공식과 직무별 영문 행동 동사 사전영문 이력서(Resume) 문장을 결과 중심으로 쓰는 공식과, 리더십/기술/조사/프로세스 등 역량별 액션 버브(행동 동사) 분류를 정리합니다.
  2. SameSite 쿠키 설정 방법, 속성 6개로 정리Domain, Path, Max-Age, SameSite, Secure, HttpOnly가 쿠키 전송 범위와 만료 시점에 각각 어떻게 작용하는지, document.cookie와 Set-Cookie 헤더 결과가 왜 다른지 코드 동작 그대로 설명합니다.
  3. 스크립트 로드 방식 시뮬레이션과 async defer 실행 시점 차이HTML 파서의 블로킹 유무를 결정짓는 <script> 태그의 async 및 defer 속성의 내부 파일 다운로드 및 실행 타임라인 차이점을 해설합니다.
  4. 스크롤바 색상 바꾸기 CSS가 안 먹히는 이유스크롤바 색상 바꾸기 CSS가 크롬에서는 되고 파이어폭스에서는 안 되는 이유를 ::-webkit-scrollbar와 scrollbar-color 문법 차이로 설명합니다. 두 브라우저용 코드를 한 번에 만드는 도구로 확인해보세요.
  5. 비밀 텍스트를 서버에 남기지 않고 공유하는 법비밀번호 같은 텍스트를 메신저로 보내면 서버에 그대로 남습니다. 브라우저에서 압축·암호화해 URL에 담아 서버 저장 없이 공유하는 원리와, 비밀번호 잠금을 켜야만 실제로 암호화되는 이유를 설명합니다.
  6. 영어 대소문자 변환기 — Sentence·Title·Snake·Kebab 케이스 규칙영문 텍스트를 Sentence Case·Title Case·snake_case·kebab-case로 바꾸는 규칙과, 대소문자 변환기에서 실제로 쓸 수 있는 옵션을 정리합니다.

관련 도구