정정지용
기술스택 목록
도구

Markdown

프로젝트 2개에서 사용했습니다. 각 프로젝트에서 어떤 역할로 썼는지 아래에 정리했습니다.

이 기술은 무엇인가요?

일반 텍스트에 간단한 기호만으로 서식을 표현하는 경량 마크업 언어

Markdown은 굵게, 목록, 링크, 제목 같은 서식을 HTML 태그 없이 몇 개의 기호로 표현할 수 있게 만든 경량 마크업 언어입니다. 복잡한 서식 도구 없이도 사람이 읽기 쉬운 원본 텍스트 자체를 그대로 유지하면서, 필요할 때 HTML 등으로 변환해 문서화 도구나 웹, 저장소 플랫폼에서 렌더링할 수 있도록 만들어졌습니다. README, 블로그 글, 문서 사이트, 커밋 메시지 등 다양한 곳에서 별도 워드프로세서 없이 빠르게 문서를 작성하려는 목적으로 널리 쓰입니다.

이럴 때 사용합니다

  • README나 정책 문서처럼 간단한 서식만 필요한 텍스트 문서를 작성할 때
  • 여러 사람이 버전 관리 시스템에서 문서 변경 이력을 텍스트 diff로 추적하고 싶을 때
  • 워드프로세서 없이 빠르게 작성하고 여러 플랫폼(깃허브, 블로그 등)에서 그대로 렌더링하고 싶을 때

핵심 개념

Plain Text
특수 프로그램 없이 텍스트 편집기만으로 작성하고 읽을 수 있는 원본 형식을 말합니다.
Rendering
작성한 Markdown 원본을 HTML 등 실제 서식이 적용된 화면으로 변환하는 과정입니다.
Syntax
제목(#), 목록(-), 강조(** **) 등 서식을 표현하는 최소한의 기호 규칙입니다.
Front Matter
문서 상단에 YAML 등으로 제목, 날짜 같은 메타데이터를 적어 넣는 확장 관례입니다.
Flavor
GitHub Flavored Markdown처럼 플랫폼마다 표, 체크박스 등을 추가로 지원하는 방언을 뜻합니다.

기본 Markdown 문서 예시

제목, 목록, 강조, 링크 등 기본 서식을 사용해 정책 문서 한 페이지를 작성한 예시입니다.

예시
# 개인정보 처리방침

본 문서는 서비스 이용 시 수집되는 정보를 설명합니다.

## 수집 항목

- 이메일 주소
- 기기 식별 정보

**중요**: 수집된 정보는 제3자에게 제공되지 않습니다.

자세한 내용은 [문의하기](mailto:support@example.com)를 참고하세요.

처음 쓸 때 흔한 함정

  • 플랫폼마다 지원하는 확장 문법이 달라 같은 문서도 다르게 렌더링될 수 있습니다.
  • 빈 줄이나 들여쓰기 하나 차이로 목록·문단 구분이 의도와 다르게 깨질 수 있습니다.

위 개요는 기술 학습을 돕기 위해 자동 생성된 일반 설명입니다. 정확한 사양과 최신 정보는 공식 문서를 확인하세요.

프로젝트별 활용 방식

위 개념이 실제 프로젝트에서 어떻게 쓰였는지 보여줍니다.

함께 사용한 기술

위 프로젝트들에서 같이 쓰인 다른 기술입니다.

GitHub PagesJekyllYAML