README.md 파일 작성을 위한 마크다운(Markdown) 기본 문법

1. MarkDown 언어란 ? 

- HTML로 변환 가능하며, 일반적으로 README.md 파일 작성을 위하여 사용하는 마크업언어

 

2. 많이 사용되는 문법

• 헤더 (Header)

- 한 개의 # 또는 다수의 #을 통하여, 헤더(h1~6) 문법 표현이 가능하다.

 

ex) 

markdown 문법	html 문법
# 헤더 1	<h1>헤더 1</h1>
## 헤더 2	<h2>헤더 2</h2>
### 헤더 3	<h3>헤더 3</h3>
#### 헤더 4	<h4>헤더 4</h4>
##### 헤더 5	<h5>헤더 5</h5>
###### 헤더 6	<h6>헤더 6</h6>

• 목록 (List)

- * 또는 1.을 통하여, 나열하려는 목록을 표현가능하다.

 

ex)

markdown 문법	html 문법
* list1	<ul><li>list1</li></ul>
1. list1 2. list2	<ol> <li>list1</li> <li>list1</li> </ol>

• 코드 블록 (Code Blocks)

- 스페이스 4번 또는 ```(언어종류) 내용``` 를 통하여, 일반 코드블록 및 언어(Python, Java 등)에 맞는 코드블록을 생성할 수 있다.

- 대표적인 지원 코드 블록

Bash (bash) C# (cs) C++ (cpp) CSS (css) Diff (diff) HTML, XML (html) HTTP (http) Ini (ini) JSON (json) Java (java) JavaScript (javascript) PHP (php) Perl (perl) Python (python) Ruby (ruby) SQL (sql)

 

ex) 일반 코드블록 (스페이스4번)

    def code_blocks():
        print("Hello World")

 

ex) 언어(python)지정 코드블록

```python 
def code_blocks():
    print("Hello World")
```