
Published on August 01, 2021 by Eunbi.N
Github markup markdown 마크다운 문법
1.1. 마크다운의 개념
Markdown은 텍스트 기반의 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다.
특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다.
깃헙의 저장소Repository에 관한 정보를 기록하는 README.md는 깃헙을 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다.
마크다운을 통해서 설치방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되면서 점점 여러 곳으로 확산되었다.
1.2. 마크다운의 장-단점
1.2.1. 장점
1.2.2. 단점
2.1. Headers
This is a H1 > This is a H2 > This is a H3 > This is a H4 > This is a H5 >
2.2. BlockQuote
이메일에서 사용하는 > 블럭인용문자를 이용한다.
This is a first blockqute.
> This is a second blockqute.
> > This is a third blockqute.
2.3. 목록
● 순서있는 목록(번호)
● 순서없는 목록(글머리 기호: *, +, - 지원)
2.4. 코드
4개의 공백 또는 하나의 탭으로 들여쓰기를 만나면 변환되기 시작하여 들여쓰지 않은 행을 만날때까지 변환이 계속된다.
2.4.1. 들여쓰기
This is a normal paragraph:
This is a 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.
2.4.1. 코드블럭
코드블럭은 다음과 같이 2가지 방식을 사용할 수 있습니다:
{code}이용방식
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");
}
}
public class BootSpringBootApplication { public static void main(String[] args) { System.out.println(“Hello, Honeymon”); } } 깃헙에서는 코드블럭코드(“```”) 시작점에 사용하는 언어를 선언하여 문법강조(Syntax highlighting)이 가능하다.
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”); } } 2.5. 수평선 <hr/> 아래 줄은 모두 수평선을 만든다. 마크다운 문서를 미리보기로 출력할 때 페이지 나누기 용도로 많이 사용한다.
2.6. 링크
// code Link: Google
Link: Google
외부링크 사용문법: Title 적용예: Google Link: Google
자동연결 일반적인 URL 혹은 이메일주소인 경우 적절한 형식으로 링크를 형성한다.
외부링크: http://example.com/
이메일링크: address@example.com
외부링크: http://example.com/
이메일링크: address@example.com
2.7. 강조
single asterisks 기울이기
single underscores 더 기울이기
double asterisks 굵게
double underscores
cancelline글자가운데줄긋기
문장 중간에 사용할 경우에는 띄어쓰기를 사용하는 것이 좋다.