본문 바로가기
IT/Programing Tip

마크다운 문법 Markdown

by DOSGamer 2019. 10. 2.
반응형

Readme 파일은 마크다운 문법으로 작성한다

소스를 작성하고 설명문서를 만들 때 마크다운 문법을 사용해서 

Readme 파일을 작성한다

 

기본적인 문법

6가지 표현방식만 알면 사용하는 데 문제 없다

  • 헤더
  • 목록
  • 링크
  • 강조
  • 이미지
  • 인용/코드

Step 1. 헤더는 큰제목, 작은제목, 글머리 1~6 으로 표현한다

큰제목은 ======================

작은제목은 -----------------------------------

글머리는 # 을 ## ### #### ##### ###### 

 

Step 2. 목록은 순서있는 목록과 순서없는 목록으로 표현한다

순서있는 목록은 1. 2. 3.

순서없는 목록은 * , + , -

 

Step 3. 링크

[Title](link) 로 표현한다

 

Step 4. 강조

*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
++underline++
~~cancelline~~

 

Step 5. 이미지

![Alt text](/path/to/img.jpg "Optional title")

 

Step 6. 인용/코드 표현

코드표현은 ``` 로 시작해서 ``` 로 끝내서 표현한다

인용표현은 > 로 표현한다

 

반응형