본문 바로가기
Language/Git

[Git] readme.md 마크다운 언어 사용법

by 애기 개발자 2022. 7. 14.
반응형

1. 헤더

헤더에는 큰 헤더와 작은 헤더가 있다.

 

1.1 큰 헤더

큰 헤더는 글 밑에 === 을 여러 번 써주면 적용된다.

 

헤더입니다. 아래에 === 을 추가하면 헤더가 됩니다. H1 =====================================================

예시)

 

 

1.2 작은 헤더

작은 헤더는 글 밑에 --- 을 여러번 써주면 된다.

 

작은 헤더입니다. 아래에 --- 을 추가하면 작은 헤더가 됩니다 H2
-----

예시)

 

1.3 H1 ~ H6 글머리

H1 ~ H6 까지 적용되며 (html과 동일) #의 개수에 따라 적용된다.

 

# H1 글머리
## H2 글머리
### H3 글머리
#### H4 글머리
##### H5 글머리
###### H6 글머리

예시)

 

 

2. 블럭

 

>를 이용해서 문단을 묶어서 처리할 수 있다.

 

> 1단 건너기
> > 2단 건너기
> > > 3단 ....

예시)

 

3. 리스트

3.1 순서 있는 리스트

그냥 번호 매기고 쓰면 알아서 적용된다.

 

1. 첫번째
2. 두번째
3. 세번째

예시)

3.2 순서 없는 리스트

● ○ ■ 의 모양으로 리스트가 만들어진다.

 

사용은  * - +  을 문장 앞에 놔주면 알아서 된다.

* 빨강
    * 녹색
        * 파랑

+ 빨강
    + 녹색
        + 파랑

- 빨강
    - 녹색
        - 파랑

예시)

 

4. 코드 블럭

4.1 들여 쓰기 방식

스페이스바 4칸 혹은 탭(스페이스 4칸에 해당하는)을 사용하여 쓸 수 있다. (파이썬과 유사)

 

This is a normal paragraph

    This is a code block

This is a normal paragraph

예시)

 

* 주의사항) 줄 간격을 한 칸 띄우고 들여 쓰기를 해야 한다. 그렇지 않으면 인식되지 않는다.

 

This is a normal paragraph
    This is a code block
This is a normal paragraph

예시)

 

4.2 태그 코드 블럭

<pre><code> 내용 </code></pre>

 

html 문법과 비슷하다. 태그를 이용해서 태그 안에 있는 내용을 코드처럼 보이게 작성 가능하다.

 

<pre>
<code>
#include <stdio.h>
int main() {
    start();
}
</code>
</pre>

예시)

4.3 ``` 코드 블럭

파이썬의 주석처럼 ``` 내용 ``` 로 코드블럭 처리를 할 수 있다.

또한 ```{언어} 내용 ``` 을 사용하면 해당 언어의 문법 강조가 가능하다.

 

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

예시)

5. 수평선

수평선은 *** / --- 를 사용하여 수평선을 넣을 수 있다.

 

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

예시)

 

6. 강조

* _ ~

위의 세 가지를 이용하여

 

강조, 취소선을 그을 수 있다.

 

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

예시)

 

7. 줄 바꿈

 

띄어쓰기 3칸을 사용하면 줄을 바꿀 수 있다.

 

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

 

예시)

 

 

출처: https://gist.github.com/ihoneymon/652be052a0727ad59601

 

마크다운(Markdown) 사용법

마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

 

 

반응형

댓글