Information

마크다운(Markdown) 문법 정리 (깃허브 리드미, README.md 파일 작성 방법)

권락현 2022. 1. 23. 23:10

 

오늘은 깃허브 리드미 파일 작성뿐 아니라 다양한 디지털 노트에서 사용되고 있는 마크다운(Markdown)이라는 언어에 대해서 알아보고 정리해보겠습니다!

 


1. 마크다운(Markdown)이란? 특징은?

  • 텍스트 기반의 마크업 언어
  • 쉽고 가볍고 간단하다.
  • 깃허브에서 README.md 파일로 많이 사용이 된다. (소스코드 설명 등의 용도로)
  • 에디터나 도구 없이도 쉽게 작성이 가능하다.
  • 변환이 쉽다.

 


2. 사용법 및 문법

 

1) 제목

  • 제목 크기에 따라 #을 붙이고 내용 입력

 

2) 구분선

  • ---와 ***로 구분선을 만들 수 있음
  • ---은 바로 위의 내용을 제목으로 만들어버림

 

3) 텍스트 효과, 강조 효과

  • *, _로 텍스트 효과를 줌
  • 중복도 가능

 

 

4) 인용구

  • > 로 인용구를 만들 수 있음
  • > 의 개수로 중복 가능

 

5) 목록, 리스트

  • 숫자 + 점으로 숫자가 있는 리스트를 만들 수 있다
  • *, -, + 으로 순서가 없는 리스트를 만들 수 있다.
  • 탭으로 간격을 주면 계층에 따라 모양이 바뀐다
  • *주의* - 숫자를 아무렇게나 넣어도 순서대로 정렬된다...

 

6) 링크 (주소, 이미지)

  • [제목](링크)의 형식으로 링크를 설정함
  • 이미지는 앞에 !를 붙여서 사용
  • 외부 경로, 내부 경로 모두 사용 가능

 

7) 코드 블록

  • `키를 이용해서 코드를 표시하거나 코드 블록을 만들 수 있음
  • ``` 뒤에 프로그래밍 언어의 종류를 적어주면 해당하는 코드에 맞추어 하이라이트를 지원

 

 

8) 테이블

  • | 를 이용하여 테이블을 만들 수 있음
  • |--| 사이에 : 표시의 위치에 따라 오른쪽, 왼쪽, 가운데 정렬을 할 수 있음

 


이상으로 간단하게 사용 가능한 마크다운 언어에 대해서 정리해보았습니다.