마크다운 문법 정리

마크다운 문법 정리 페이지

마크다운을 사용하는 모든 곳에서 적용 가능한 문법과
옵시디언에서만 적용되는 문법을 구분해서 작성함

 

0. 마크다운 문법에 사용되는 기호 표시

마크다운에 사용되는 #이나 - * ~같은 기호들은
앞에 백슬래쉬를 붙이면 사용 가능
\- \# \* 등등

 

1. 제목(Headers)

제목을 만들땐 #과 띄어쓰기 한칸을 사용
#의 갯수에 따라 제목의 크기가 달라짐(1개가 가장 크고 6개가 가장 작음)

# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6

결과)

제목 1

제목 2

제목 3

제목 4

제목 5
제목 6

 

2. 기울임(이탤릭체)

텍스트를 이탤릭체로 표시하려면 *또는 _로 감싸면 됨

*텍스트*
_텍스트_

결과)
텍스트
_텍스트 _

 

3. 두껍게(Bold체)

텍스트를 두껍게 표시하려면 ** 또는 __로 감싸면 됨

**텍스트**
__텍스트__

결과)
텍스트
텍스트

 

4. 취소선

텍스트에 취소선을 그으려면 ~~로 감싸면 됨

~~~텍스트~~~ 

결과)
텍스트

 

5. 리스트

순서가 있는 리스트와 순서가 없는 리스트 작성 가능

  1. 순서가 있는 리스트
    숫자와 점을 사용
1. 리스트 1
2. 리스트 2
3. 리스트 3

결과)

  1. 리스트 1
  2. 리스트 2
  3. 리스트 3
  1. 순서가 없는 리스트
    - + *를 사용해서 작성
- 리스트 1
+ 리스트 2
* 리스트 3

결과)

  • 리스트 1
  • 리스트 2
  • 리스트 3

 

6. 링크(Links)

외부링크 삽입

[링크 텍스트](URL) 형식을 사용

[옵시디언 깃허브](https://github.com/batsalee/Obsidian) 

결과)
옵시디언 깃허브

 

7. 이미지(Images)

이미지 삽입 및 이미지 크기 조정
![이미지 설명](이미지 URL)로 구현

![위키피디아 흑요석](https://upload.wikimedia.org/wikipedia/commons/thumb/8/8c/ObsidianOregon.jpg/360px-ObsidianOregon.jpg) 

결과)

위키피디아 흑요석

단, 일반적인 마크다운 문법으로 이미지를 올리면 사진의 크기조절이 불가능하다.
옵시디언에서만 적용 가능한 이미지 크기 조절 문법이 있지만
다른 플랫폼에서 이미지의 크기를 조절하려면 HTML 태그를 사용해야 한다.
<img src="https://url/image.png" width="50" height="50">

옵시디언에서만 적용 가능한 이미지 크기 조절 방법


![이미지 설명|가로x세로](이미지 URL)로 구현한다.

![위키피디아 흑요석](https://upload.wikimedia.org/wikipedia/commons/thumb/8/8c/ObsidianOregon.jpg/360px-ObsidianOregon.jpg){width=100x100} 

결과)

위키피디아 흑요석

 

8. 인용구

인용구를 만드려면 >를 사용
또한 인용구 내부에서도 마크다운 문법이 적용된다.

> 외부 인용 문구
> **두껍게**
> ~~취소선~~

결과)

외부 인용 문구
두껍게
취소선

 

9. 코드(Code)

한줄짜리 인라인코드는 `로 감싸고
여러줄짜리 코드블록은 ```로 감싸면 된다.

또한 코드블록의 경우 ```C++ 처럼 ```의 오른쪽에 언어명을 작성해주면
해당 언어에 맞게 하이라이트된다.

결과)
if(true) cout << "Hello World!";

if(true) cout << "Hello World!";

 

10. 수평선

수평선을 추가하려면 ___ 또는 --- 또는 ***을 사용

___
---
***

결과)




주의할 점은 ---을 사용한 수평선은 윗줄에 문자가 있으면 윗줄의 문자를 제목(#)으로 인식한다.
가능하면 ---보다는 ___사용을 습관화 해보면 좋을 듯

 

11. 각주

[^1]처럼 작성해서 텍스트에 각주를 표시하고, 페이지 하단에 각주에 대한 설명을 작성

각주[^1] 사용 예시[^2]입니다.
[^1]: 각주에 대한 설명입니다.
[^2]: 각주 설명을 여러줄 작성하려면
  새 줄의 맨 앞에 공백 2칸을 추가하면 됩니다.

결과)
각주[1] 사용 예시[2]입니다.

 

각주에 이름을 지정하고 싶다면 [^이름]으로 작성
편집창에서만 이름으로 보이고 결과화면에서는 동일하게 숫자로 표시되므로
편집을 편하게 하는 용도로 생각하면 될듯

이름이 지정된 각주[^note]입니다.
[^note]: 이름이 지정된 각주에 대한 설명입니다.

결과)
이름이 지정된 각주[3]입니다.

 

12. 표 그리기

|와 -를 사용해서 구현하며 제목줄만 만들면 Enter나 Tab을 눌러서 쉽게 생성 가능
|와 글씨 사이에 공백 한칸이 필요함

제목줄을 만든 후 Enter를 누르면 아래로 행이 추가되며
Tab을 누르면 오른쪽으로 열이 추가됨

| 열 제목 1 | 열 제목 2 |
| --------- | --------- |
| 내용 1    | 내용 2    |
| 내용 3    | 내용 4    |

결과)

열 제목 1 열 제목 2
내용 1 내용 2
내용 3 내용 4

 

정렬

좌측 정렬은 :—
우측정렬은 —:
가운데 정렬은 :—:
- 의 갯수는 중요하지 않은 듯

| 좌측 정렬 | 가운데 정렬 | 우측 정렬 |
| :-------- | :--------: | ---: |
| 내용 1    | 내용 2    | 내용 3 |
| 내용 6    | 내용 5    | 내용 6 |

결과)

좌측 정렬 가운데 정렬 우측 정렬
내용 1 내용 2 내용 3
내용 6 내용 5 내용 6

옵시디언 전용 마크다운 문법 정리

아래 내용은 옵시디언에서만 적용 가능한 마크다운 문법들

1. 하이라이트

마크다운에는 원래 텍스트 하이라이트 기능(형광펜)이 없고, 옵시디언에 추가되어 있는 기능
==를 사용해서 표현

==하이라이트==
결과)

하이라이트

 

2. 체크박스

- [ ]를 사용해서 할 일 목록을 표현하는 문법
-와 [ ]사이에 공백이 한칸씩 있어야 함
Ctrl + L단축키로 작성 가능

[와 ]사이에 아무 문자를 하나 적으면 완료한 목록이 됨
일반적으로 완료시 x를 적어서 체크함

- [ ] 할일 목록 만들기
- [X] 이미 완료한 할 일

결과)

 

3. 이미지 크기 조절

옵시디언에서만 적용 가능한 이미지 크기 조절 방법은
![이미지 설명|가로x세로](이미지 URL)로 구현한다.

![위키피디아 흑요석](https://upload.wikimedia.org/wikipedia/commons/thumb/8/8c/ObsidianOregon.jpg/360px-ObsidianOregon.jpg){width=100x100} 

위키피디아 흑요석

 

4. 문서 내부 링크

내부 링크는 노트 간 또는 블록 간 연결되는 링크

[[]]를 사용해서 구현하며 안에 노트파일명을 넣으면 해당 노트파일로 이동한다.  

 

[[Hello Obsidian]]

결과)   

 [[Hello Obsidian]]

 

 5. 문서 임베딩

문서 내부 링크는 링크를 타고 해당 파일로 이동하는 것이지만  
문서 임베딩은 다른 노트의 내용 자체를 가져와서 박아놓는 것  
![[]]를 사용해서 구현  

예를들어 `![[Protected]]`처럼 사용  

 

6. 문단 참조(Block Reference)

문단 임베딩이라고 생각하면 이해가 빠를 듯  
문서를 다 임베딩 하는게 아니라 다른 노트파일에 있는 한 문단만 가져와서 인용하는 것  

1) 임베딩될 문단이 있는 파일에 가서 해당 문단의 끝에 ^myid로 id를 부여하고  
2) 임베딩할 파일에서 ![[파일명#^myid]]을 작성하면 해당 문단만 인용된다.  

 

7. 강조 상자 넣기(말풍선)

내용을 작성하다 강조하고 싶은 부분이 있을 때 Callout을 사용해서 작성하면 좋음  

예시)  

> [!note] 여길 주목하세요!
> 강조 상자를 사용할 수 있습니다.

 

결과)  
> [!note] 여길 주목하세요!
> 강조 상자를 사용할 수 있습니다.

위에서 [!note]같은걸 Callout이라고 부름  
Callout문법을 작성하면 위처럼 알맞은 아이콘 및 색상이 들어간 상자가 생성됨

  

Callout 종류

같은 줄에 작성된 단어들은 같은 기능  
- [!note]
- [!abstract], [!summary], [!tldr]
- [!info]
- [!todo]
- [!tip], [!hint], [!important]
- [!success], [!check], [!done]
- [!question], [!help], [!faq]
- [!warning], [!caution], [!attention]
- [!failure], [!fail], [!missing]
- [!danger], [!error]
- [!bug]
- [!example]
- [!quote], [!cite]


  1. 각주에 대한 설명입니다. ↩︎
  2. 각주 설명을 여러줄 작성하려면
    새 줄의 맨 앞에 공백 2칸을 추가하면 됩니다. ↩︎
  3. 이름이 지정된 각주에 대한 설명입니다. ↩︎