마크다운(Markdown) 작성 방법
마크다운(Markdown) 작성 방법과 대표 예제를 정리하여 안내드립니다. 마크다운은 간단한 문법으로 문서를 구조화하고 읽기 쉽게 만드는 표준 텍스트 포맷입니다. 주로 README, 문서화, 블로그, 노트 등에 사용됩니다.
주의: 플랫폼마다 일부 문법이나 렌더링 방식이 다를 수 있습니다(GitHub, Notion, Obsidian 등). 기본 문법은 대부분 호환됩니다.
- 제목(Headings)
제목 1
제목 2
제목 3
제목 4
제목 5
제목 6
예:
프로젝트 개요
기능 설명
설치 방법
- 문단과 줄바꿈
- 빈 줄을 하나 추가하면 새로운 문단이 됩니다.
- 줄 끝에 두 칸 공백을 넣거나
태그를 사용하면 줄바꿈을 강제할 수 있습니다.
예:
첫 번째 문단입니다.
두 번째 문단입니다.
- 강조(굵게, 기울임, 취소선)
- 굵게: 텍스트 또는 텍스트
- 기울임: 텍스트 또는 텍스트
- 굵게+기울임: 텍스트
- 취소선:
텍스트
예:
중요 사항입니다. 참고 내용도 있습니다. 더 이상 사용하지 않음
- 목록(Lists)
- 순서 없는 목록: -, *, + 사용
- 순서 있는 목록: 숫자. 형식
예:
- 사과
- 바나나
- 포도
- 준비
- 설치
- 실행
하위 목록(들여쓰기 두 칸 또는 탭):
- 항목 A
- 하위 A1
- 하위 A1-1
- 하위 A1
- 링크와 이미지
예:
공식 문서
- 코드(Code)
- 인라인 코드:
코드 - 코드 블록(언어 지정 가능): ```언어
예:
문장 중 printf()를 사용합니다.
python
def add(a, b):
return a + bbash
# 설치
pip install package- 인용문(Blockquote)
기호 사용. 중첩 가능.
예:
핵심 요약
세부 설명
- 수평선(Horizontal rule)
- --- 또는 *** 또는 ___
예:
- 표(Table)
- | 컬럼1 | 컬럼2 |
- |---|---| 로 구분선 작성
- :---, :---:, ---: 로 정렬
예:
| 이름 | 점수 | 비고 |
|---|---|---|
| 홍길동 | 95 | 우수 |
| 김철수 | 88 | 보통 |
- 체크박스(Task list)
- 할 일
- 완료
예:
- 문서 검토
- 초안 작성
- 이스케이프(Escape)
- 특수문자 그대로 표기: * _ # [ ] ( )
예:
별표를 쓰려면 * 두 개를 입력하세요.
- 각주(Footnotes) 지원 플랫폼에서
- 본문: 문장입니다.[^1]
- 아래: [^1]: 각주 내용
예:
참고 문서 확인.[^ref]
[^ref]: 상세 출처입니다.
- 접기/요약(Details) HTML 활용
- 일부 플랫폼에서 지원:
제목
예:
더 보기
추가 설명입니다.종합 예제(README 스타일)
프로젝트 이름
간단한 소개 문구를 여기에 작성합니다.
목차
특징
- 가벼운 설치
- 빠른 성능
- 확장 가능한 구조
설치
bash
git clone https://github.com/user/repo.git
cd repo
pip install -r requirements.txt사용법
python
from app import run
run(mode="demo")- 설정 파일:
config.yaml - 로그 경로: ./logs/
예시 출력
| 단계 | 설명 | 상태 |
|---|---|---|
| 1 | 데이터 로드 | 완료 |
| 2 | 전처리 | 진행중 |
| 3 | 분석 | 대기 |
라이선스
이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE를 확인하십시오.
댓글
댓글 쓰기