마크다운 (markdown) 작성 하는 방법

마크다운 (markdown) 작성 하는 방법

• 안녕하세요.
• 오늘은 마크다운(markdown) 작성하는 방법에 대해서 알려 드리려고 합니다.

참조

• https://gist.github.com/ihoneymon/652be052a0727ad59601
• https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4

마크다운이란?

• 마크다운(markdown) 은 일반 텍스트 기반의 경량 마크업 언어입니다.
• 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징입니다.
• HTML과 리치 텍스트(RTF) 등 서식 문서로 쉽게 변환되기 때문에 응용 소프트웨어와 함께 배포되는 README 파일이나 온라인 게시물 등에 많이 사용됩니다.

마크다운 장/단점

1.1 장점

• 간결하다.
• 별도의 도구 없이 작성 가능하다.
• 다양한 형태로 변환이 가능하다.
• 텍스트로 저장되기 때문에 용량이 적어 보관이 용이하다.
• 텍스트 파일이기 때문에 버전관리 시스템을 이용하여 변경 이력이 용이하다.
• 지원하는 프로그램과 플랫폼이 다양하다.

1.2 단점

• 표준이 없다.
• 표준이 없기 때무에 도구에 따라서 변환방식이나 결과물들이 다르다.
• 모든 HTML 마크업을 대신하지는 못한다.

마크다운 문법들

헤더 Headers

# This is a H1
## This is a H2
### This is a H3
#### This is a H4
##### This is a H5
###### This is a H6

This is a H1

This is a H2

This is a H3

This is a H4

This is a H5

This is a H6

####### This is a H7 은 지원하지 않습니다.

BlockQuote

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

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

This is a first blockqute.

This is a second blockqute.

This is a third blockqute.

목록(list)

순서 있는 목록(번호)

• 순서 있는 목록은 숫자와 점을 사용합니다.
  ```

1. 첫번째

2. 두번째

3. 세번째

4. 첫번째

5. 두번째

6. 세번째

• 현재까지는 어떤 번호를 입력해도 순서는 내림차순으로 정의됩니다.

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

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

순서 없는 목록(글머리 기호 : *, +, - 지원)

* 빨강
  * 녹색
    * 파랑

+ 빨강
  + 녹색
    + 파랑

- 빨강
  - 녹색
    - 파랑

• 빨강

  • 녹색
    • 파랑

• 빨강

  • 녹색
    • 파랑

• 빨강

  • 녹색
    • 파랑

코드

• 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.

코드 블럭

• 코드 블럭은 다음과 같이 2가지 방식을 사용할 수 있습니다.
• <pre><code>{code{</code></pre> 이용방식

<pre>
<code>
public class BootSpringBootApplication {
  public static void main(String[] args) {
    System.out.println("Hello, Honeymon");
  }

}
</code>
</pre>

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

• 코드블럭코드("```") 을 이용하는 방법

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

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

• Github에서는 코드 블럭 코드("````")시작점에 사용하는 언어를 선언하여 문법강조 가능합니다.

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

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

강조

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

single asterisks
single underscores
double asterisks
double underscores
cancelline

문장 중간에 사용할 경우에는 **띄어쓰기** 사용하는 것이 좋습니다.
문장 중간에 사용할 경우에는 띄어쓰기를 사용하는 것이 좋다.

줄바꿈

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

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

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

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

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