Markdown

GitHub에서 Markdown을 사용하여 문서를 작성하는 것은 프로젝트의 가독성과 협업을 크게 향상시킬 수 있습니다. 아래는 Markdown을 활용하여 GitHub에서 사용할 수 있는 기본적인 양식입니다.

 

1. Markdown 소개

Markdown이란?

Markdown은 간단한 마크업 언어로, 사람이 읽고 쓰기 쉬운 텍스트 파일 형식으로 문서를 작성할 수 있도록 합니다. HTML과 달리 복잡한 코드를 사용하지 않고, 기호와 문법을 통해 문서의 서식을 지정할 수 있어 누구나 쉽게 접근할 수 있다는 장점이 있습니

GitHub에서의 Markdown의 중요성

주요 활용 분야:

• README 파일: 프로젝트 소개, 설치 방법, 사용 설명 등을 Markdown으로 작성
• 코드 블럭: 코드 예시를 쉽게 표시하고 설명
• 이슈 및 댓글: Markdown을 사용하여 가독성 높은 텍스트 작성
• Wiki: 프로젝트 관련 문서, FAQ 등을 체계적으로 관리

Markdown 사용 장점:

• 코드와의 통합: 코드 블럭과 함께 문서 작성 가능
• 간편한 협업: 팀원들과 쉽게 문서 작성 및 수정 가능
• 버전 관리: Markdown 파일의 변경 사항을 Git으로 관리
• 다양한 렌더링: GitHub Flavored Markdown 등 다양한 렌더링 엔진 지원

2. 기본 문법

2.1 제목 (Headings)

• # 부터 ###### 까지 사용하여 h1부터 h6까지의 제목을 만들 수 있음.

# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

2.2 강조 (Emphasis)

• 이탤릭체는 * 또는 _ 로, 볼드체는 ** 또는 __ 로 감싸서 사용

_이탤릭체_
_이탤릭체_
**볼드체**
**볼드체**

2.3 목록 (Lists)

• 순서가 있는 목록과 순서가 없는 목록

 *순서 없는 목록
   - 순서 없는 목록
       * 3단계

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

• 1단계
  • 2단계
    • 3단계

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

2.4 링크 (Links)

• [텍스트](URL) 형식을 사용하여 링크 삽입.

[Google](https://www.google.com)

2.5 이미지 (Images)

•  형식을 사용하여 이미지 삽입.


사이즈 조절 기능은 없기 때문에 <img width="" height=""></img>를 이용한다.

<img src="/path/to/img.jpg" width="450px" height="300px" title="px(픽셀) 크기 설정" alt="RubberDuck"></img><br/>
<img src="/path/to/img.jpg" width="40%" height="30%" title="px(픽셀) 크기 설정" alt="RubberDuck"></img>

 

2.6 코드 (Code)와 코드 블록 (Code Blocks)

• 4개의 공백 또는 하나의 탭으로 들여쓰기를 만나면 변환되기 시작하여 들여쓰지 않은 행을 만날때까지 변환이 계속된다.
• 인라인 코드는 `로 감싸고, 코드 블록은 ```로 감싸서 사용.

This is a normal paragraph:

    This is a code block

end code block.

적용 예:

 

This is a normal paragraph:

 This is a code block

 

end code block.

한줄 띄워쓰지 않으면 인식이 제대로 안되는 문제가 발생합니다.

This is a normal paragraph:
    This is a code block
end code block.

적용예:

This is a normal paragraph: This is a code block. end code block.

 

• 코드블럭코드 이용 방법

```
public class BootSpringBootAplication {
   public static void main(String[] args) {
     System.out.println("Hello, Honeymon");
   }
}
```

• 깃헙에서는 코드블럭코드("```") 시작점에 사용하는 언어를 선언하여 문법강조(Syntax highlighting)이 가능하다.

```java
public class BootSpringBootAplication {
   public static void main(String[] args) {
     System.out.println("Hello, Honeymon");
   }
}
```

public class BootSpringBootAplication {
   public static void main(String[] args) {
     System.out.println("Hello, Honeymon");
   }
}

2.7 BlockQuote

이메일에서 사용하는 > 블럭인용문자를 이용한다.

> This is a first blockqute.
>      >  This is a second blockqute
>      >      >  This is a thirdblockqute.

This is a first blockqute.

This is a second blockqute.

This is a third blockqute.

이 안에서는 다른 마크다운 요소를 포함할 수 있다.

This is a H3

• List

 

2.8 수평선 <hr/>

• 아래 줄은 모두 수평선을 만든다. 마크다운 문서를 미리보기로 출력할 때 페이지 나누기 용도로 많이 사용한다.

* * *
***
*****
- - -
----------------------------------

• 적용예:

---

---

---

---

---

2.9 줄바꿈

• 3칸 이상 띄어쓰기( )를 하면 줄이 바뀐다.

* 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다. 
이렇게

* 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다.___\\ 띄어쓰기
이렇게

• 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다. 이렇게
• 줄 바꿈을 하기 위해서는 문장 마지막에서 3칸이상을 띄어쓰기해야 한다.
  이렇게