마크다운 문법(Markdown) 사용법 정리

Jaehyun Jang·2024년 1월 3일
0
post-thumbnail

마크다운 문법이란?

마크다운(Markdown)은 텍스트 기반의 마크업 언어로, 특정한 문법을 사용하여 문서를 작성하는 데에 사용된다. 마크다운은 읽기 쉽고 쓰기 쉬우면서도 HTML 등의 다른 마크업 언어로 변환이 용이한 특징이 있다. 주로 간단한 형식의 문서, 블로그 게시물, 이메일, 온라인 포럼 등에서 사용된다.

나는 주로 Github의 Readme.mdvelog를 작성할 때 사용한다.


문법 정리

제목(Headers)

# 제목 1
## 제목 2
### 제목 3
...

velog는 Headers에 따라 목차를 알아서 생성해준다.

참고 : 회색 박스 (인라인코드) 사용법 백틱( ` ) 로 앞뒤를 감싸주면 이렇게 사용할 수 있다.


볼드와 이탤릭(Bold and Italic)

**볼드** 또는 __볼드__
*이탤릭* 또는 _이탤릭_

볼드 <-> 볼드
이탤릭 <-> 이탤릭


목록(Lists)

순서가 있는 목록:

1. 항목 1
2. 항목 2
3. 항목 3
  1. 이렇게
  2. 쓸 수
  3. 있다

순서가 없는 목록:

- 항목 1
- 항목 2
- 항목 3
  • 마찬가지로
  • 이렇게
  • 쓸 수 있다

[링크 텍스트](URL)

나의 벨로그로 이동하기

이렇게 사용하면 된다.


이미지(Images)

![대체 텍스트](이미지 URL)

또는

<img src="이미지 링크" width="n%" height="n%">

로고


인용문(Blockquotes)

> 인용문 내용

인용문을 사용하면 이렇게 된다.


코드(Code)

```
코드 내용
```

이렇게 사용하면 된다.

또는 해당 언어의 문법을 강조하여 나타내고 싶은 경우,

```python
import pytorch
import numpy as np

def sum(a, b):
	return a+b
```

이런식으로 사용하면 아래와 같이 문법에 따라 강조하여 나타낼 수 있다.

import pytorch
import numpy as np

def sum(a, b):
	return a+b

수평선(Horizontal Line)

---

수평선을 통해서 단락간 분리를 하면 좋다


테이블(Table)

| Name | Contact | Role |
|:----------|:----------:|:----------|
| **홍길동(Leader)** | <hongildong@gmail.com> | Visual SLAM <br> LiDAR SLAM|
| 신사임당 | <sinsaimdang@gmail.com> | Local planning |
| 장영실 | <youngsil@gmail.com> | Global planning |
| 이순신| <turtleship@gmail.com> | Control |

사용법
| 로 구분하며, 위에서 설명한 기본적인 스타일 적용이 가능하며 -(하이픈)으로 구분된 곳 각각 왼쪽, 양쪽, 오른쪽에 :(세미콜론)을 붙일 경우 순서대로 왼쪽 정렬, 가운데 정렬, 오른쪽 정렬이 가능하다. 셀 내부에서 다음 줄로 넘기기 위해선 <br>를 입력하고 작성한다.

결과는 다음과 같다.

NameContactRole
홍길동(Leader)hongildong@gmail.comVisual SLAM
LiDAR SLAM
신사임당sinsaimdang@gmail.comLocal planning
장영실youngsil@gmail.comGlobal planning
이순신turtleship@gmail.comControl

체크박스

"["와"]"사이를 빈칸으로 띄움.
"["와"]"사이에 x를 넣으면 완료된 체크박스


마크다운은 다양한 환경에서 지원되며, 다양한 변형이 존재할 수 있다. 문법은 상대적으로 간단하지만 다양한 형식의 문서 작성이 가능하며, 이 문법을 사용하면 텍스트를 더 읽기 쉽게 표현하고, 일반 텍스트로도 읽을 수 있는 형태로 저장할 수 있다.


그러니 열심히 써보고 익혀보자!


Reference

profile
그냥 내가 공부하는거 안까먹으려고 만든 벨로그

0개의 댓글