- Published on
Markdown Guide
- Authors
- Name
- Chaneun Yeo
Introduction
.md 파일과 .mdx 파일 파싱은 unified와 remark, rehype 패키지로 이루어집니다. next-mdx-remote는 Webpack을 건드리지 않고 보다 유연한 방식으로 .md 파일과 .mdx 파일을 파싱할 수 있게 해줍니다.
GitHub에서 사용되는 markdown이 사용되었습니다. mdx-prism은 코드 블록에 대한 구문 강조 기능을 제공합니다. 다음은 markdown이 어떻게 작성되고 보이는 지에 대한 예시입니다.
이 포스트에서는 Markdown 뿐만이 아닌 Mdx파일에 대한 추가적인 기능도 다룹니다.
이 포스트의 makrdown 설명서는 다음 페이지를 바탕으로 수정 및 추가 되었습니다 : https://guides.github.com/features/mastering-markdown/
Docusaurus에서도 markdown 문법과 블로그에서 사용하는 추가적인 여러 도구들을 확인해볼 수 있습니다. https://docusaurus.io/ko/docs/next
What is Markdown?
Markdown은 웹에서 텍스트의 스타일을 지정하는 방법입니다. 지금 읽고 있는 이 문서의 display 또한 유려하게 제어할 수 있습니다. 단어를 굵게 또는 기울임꼴로 서식을 지정하고, 이미지를 추가하고, 목록을 만드는 것은 Markdown으로 수행할 수 있는 작업 중 일부에 불과합니다. 대부분 Markdown은 또는 #과 * 같이 알파벳이 아닌 문자가 몇 개 포함된 일반 텍스트로 이뤄져있습니다.
Syntax guide
다음은 GitHub 또는 사용자 고유의 텍스트 파일에서 사용할 수 있는 Markdown 및 Mdx 구문에 대한 개요입니다.
목차 ToC (Table of Contents)
<TOCInline toc={props.toc} asDisclosure />
Table of Contents
- Introduction
- What is Markdown?
- Syntax guide
- 목차 ToC (Table of Contents)
- 줄바꿈 Line break
- 헤더 Headers
- This is a h1 tag
- This is a h2 tag
- This is a h4 tag
- 강조 Emphasis
- 취소선 Strikethrough
- 리스트 Lists
- 순서 x Unordered
- 순서 o Ordered
- 사진 Images
- 하이퍼링크 Links
- 인용구 Blockquotes
- 코드 하이라이팅 Inline code
- 문법 하이라이팅 Syntax highlighting
- 각주 Footnotes
- 체크 박스 Task Lists
- 표 Tables
줄바꿈 Line break
a b c\
a
b
c
a <br /> <br /> b <br /> <br /> c
a b c
a b c
a
b
c
헤더 Headers
# This is a h1 tag
## This is a h2 tag
#### This is a h4 tag
This is a h1 tag
This is a h2 tag
This is a h4 tag
강조 Emphasis
_This text will be italic_
**This text will be bold**
_You **can** combine them_
This text will be italic
This text will be bold
You can combine them
취소선 Strikethrough
Any word wrapped with two tildes (like `~~this~~`) will appear ~~crossed out~~.
Any word wrapped with two tildes (like ~~this~~) will appear crossed out.
리스트 Lists
순서 x Unordered
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 1
- Item 2
- Item 2a
- Item 2b
순서 o Ordered
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
사진 Images

Format: 

하이퍼링크 Links
http://github.com - http로 시작하면 링크 자동생성
[GitHub](http://github.com)
http://github.com - http로 시작하면 링크 자동생성
GitHub
인용구 Blockquotes
As Kanye West said:
> We're living the future so
> the present is our past.
>> This is double blockquotes
As Kanye West said:
We're living the future so the present is our past.
This is double blockquotes
코드 하이라이팅 Inline code
I think you should use an
`<addr>` element here instead.
I think you should use an <addr> element here instead.
문법 하이라이팅 Syntax highlighting
GitHub Markdown 에서 사용할 수 있는 Syntax higlighting :
```js:fancyAlert.js
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
```
아래는 결과물 - 개이뿌덩
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
각주 Footnotes
Here is a simple footnote[^1]. With some additional text after it.
[^1]: My reference.
Here is a simple footnote1. With some additional text after it.
체크 박스 Task Lists
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
표 Tables
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:
| First Header | Second Header |
| --------------------------- | ---------------------------- |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
| First Header | Second Header |
|---|---|
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
Footnotes
My reference. ↩