마크다운 작성법

minide·2020년 12월 29일
0

차곡차곡

목록 보기
2/4
post-thumbnail

마크다운 작성법

1. 마크다운이란

Markdown은 텍스트 기반의 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTMLFH 변환이 가능하다. 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다. 마크다운이 최근 각광받기 시작한 이유는 깃허브(https://github.com) 덕분이다. 깃허브의 저장소 Repository에 과한 정보를 기록하는 README.md라는 깃허브를 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다. 마크다운을 통해서 설치방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되면서 점점 여러 곳으로 퍼져가게 된다.

1-1.마크다운의 장점

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

1-2. 마크다운의 단점

1. 표준이 없다.
2. 표준이 없기 때문에 도구에 따라서 변환방식이나 생성물이 다르다.
3. 모든 HTML 마크업을 대신하지 못한다.

2. 마크다운 문법

2-1. 헤더

  • 글머리 : 1~6까지 지원
# 헤더1
## 헤더2
### 헤더3
#### 헤더4
##### 헤더5
###### 헤더6

헤더1

헤더2

헤더3

헤더4

헤더5
헤더6

2-2. 블럭인용

> 블럭인용

블럭인용

블럭인용은 연쇄적으로도 가능하다.

> 블럭인용
>> 블럭인용
>>> 블럭인용

블럭인용

블럭인용

블럭인용

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

> ### 헤더3
    - 리스트
 	```
 	코드
 	```

헤더3

  • 리스트
코드

2-3. 목록

  • 순서있는 목록(번호)
    순서있는 목록은 숫자와 점을 사용한다.
1. 첫 번째
2. 두 번째
3. 세 번째
  1. 첫 번째
  2. 두 번째
  3. 세 번째

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

  • 순서없는 목록(*, +, -)
* 안녕
  * 잘가
    * 그래

+ 안녕
  + 잘가
    + 그래
    
- 안녕
  - 잘가
    - 그래    
  • 안녕
    • 잘가
      • 그래
  • 안녕
    • 잘가
      • 그래
  • 안녕
    • 잘가
      • 그래

혼합해서 사용하는 것도 가능하다.

2-4. 코드

코드블럭을 다음 2가지 방식으로 사용할 수 있다.

  • <pre><code>{code}</code></pre>를 이용
<pre>
<code>
public class practice {
    public static void main(String [] args){
        System.out.println("Pull Request Test");
    }
}
</code>
</pre>

public class practice {
    public static void main(String [] args){
        System.out.println("Pull Request Test");
    }
}

  • 코드블럭코드(```)를 이용

2-5. 수평선

<hr/>
* * *
***
*****
- - -
-----------------------------------------

2-6. 링크

  • 참조링크
[link keyword][id]

[id]: URL "Optional Title here"

링크 : velog@minide

  • 외부링크
[Title](link)

링크 : velog@minide

  • 자동연결
    일반적인 URL 혹은 이메일주소인 경우 적절한 형식으로 링크를 형성한다.
외부링크 : <http://example.com/>
이메일링크 : <address@example.com>

2-7. 강조

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

single asterisks

single underscores

double asterisks

double underscores

~~cancelline~~

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

2-8. 이미지

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")


  • 이미지에 링크 삽입
[![Alt text](/path/to/img.jpg)](URL)

이미지 URL : https://github.com/jeongyuneo/2021-Java-Study/blob/jeongyun/image/testimg.jpeg

  • 이미지 사이즈 조절
<img src="이미지경로" width="" height=""></img>




<img src="https://images.velog.io/images/minide/post/b2763cf5-3351-4ee7-ad1d-d33fcfa43d69/%EB%B0%B0%EA%B2%BD%ED%99%94%EB%A9%B4.jpeg" width="450px" height="300px" title="픽셀 크기 설정" alt="test image"></img><br/>
<img src="https://images.velog.io/images/minide/post/b2763cf5-3351-4ee7-ad1d-d33fcfa43d69/%EB%B0%B0%EA%B2%BD%ED%99%94%EB%A9%B4.jpeg" width="40%" height="30%" title="픽셀 크기 설정" alt="test image"></img><br/>




참고 : 마크다운 markdown 작성법

profile
아무것도 몰라요

0개의 댓글