Markdown Syntax ๋งํฌ๋ค์ด ์์ฑ๋ฒ
๋งํฌ๋ค์ด(Markdown)์ ์ผ๋ฐ ํ
์คํธ ๋ฌธ์์ ์์์ ํธ์งํ๋ ๋ฌธ๋ฒ์
๋๋ค.
READMEํ์ผ์ด๋ ์จ๋ผ์ธ ๋ฌธ์, ํน์ ์ผ๋ฐ ํ
์คํธ ํธ์ง๊ธฐ๋ก ๋ฌธ์ ์์์ ํธ์งํ ๋ ์ฐ์
๋๋ค.
๋งํฌ๋ค์ด์ ์ด์ฉํด ์์ฑ๋ ๋ฌธ์๋ ์ฝ๊ฒ HTML ๋ฑ ๋ค๋ฅธ ๋ฌธ์ํํ๋ก ๋ณํ์ด ๊ฐ๋ฅํฉ๋๋ค.
์กด ๊ทธ๋ฃจ๋ฒ๋ 2004๋
์ ๋ฌธ๋ฒ ๋ฉด์์ ์๋ฐ ์ค์์ธ ์ ์ค๋ํ ํ์
์ ํตํด ๋งํธ๋ค์ด ์ธ์ด๋ฅผ ๋ง๋ค์์ผ๋ฉฐ, ์ฌ๋๋ค์ด ์ผ๊ธฐ ์ฝ๊ณ ์ฐ๊ธฐ ์ฌ์ด ํ๋ ์ธ ํ
์คํธ ํฌ๋งท์ ์ฌ์ฉํ์ฌ ์ธ ์ ์์ผ๋ฉด์ ๊ตฌ์กฐ์ ์ผ๋ก ์ ํจํ HTML๋ก ์ ํ์ ๋ณํ์ด ๊ฐ๋ฅํฉ๋๋ค.John Gruber (DaringFireball).
Markdown Pros ๋งํฌ๋ค์ด ์ฅ์
- ์ฝ๊ธฐ ์ฝ๋ค. ํ์คํ ๋งํฌ๋ค์ด์ ๋ค๋ฅธ ๋งํฌ์ ์ธ์ด์ ๋นํด ๊ฐ๋ ์ฑ์ด ์ข์ต๋๋ค. ๋ฌธ๋ฒ๋ ๋จ์ํ๊ณ , HTML์ ์์ฑํ๋ฉด์ ๋ธ๋ผ์ฐ์ ์์ ์ด๋ป๊ฒ ๋ณด์ฌ ์ง์ง ์์ํ๋๊ฒ ์ฝ์ง ์์ง๋ง, ๋งํฌ๋ค์ด์ ์ฌ์ฉํ ํ ์คํธ๋ ๋ธ๋ผ์ฐ์ ์ ๋ณด์ฌ์ง ๋ด์ฉ์ ์ฝ๊ฒ ์์ํ ์ ์์ต๋๋ค.
- ์ตํ๊ธฐ ์ฝ๋ค. ์กด ๊ทธ๋ฃจ๋ฒ๋ ์ฌ๋๋ค์ด ๋ง์ด ์ฌ์ฉํ๋ ๊ฒ์ ๋งํฌ๋ค์ด์ผ๋ก ์ฌ์ฉํ๊ณ , ๋ณต์กํ ๊ฒ์ HTML๋ก ์ฌ์ฉํ๊ธฐ ๋ฐ๋ฌ์ต๋๋ค. ๊ทธ๋์ ๋ฌธ๋ฒ์ด ๋งค์ฐ ๊ฐ๋จํฉ๋๋ค. ๊ทธ๋ฆฌ๊ณ ๋งํฌ๋ค์ด์ผ๋ก ๊ธ์ ์์ฑํ ๋, ์ ํ์ ์ธ ๊ธฐ๋ฅ ๋ช ๊ฐ๋ฅผ ์ ์ธํ๊ณ HTML์ ํจ๊ป ์ฌ์ฉํด๋ ์๊ด์์ต๋๋ค.
- ๋ชจ๋ฐ์ผ ์นํ์ ์ด๋ค. ๋จ์ํ ํ ์คํธ๋ง ์์ฑํ๋ ๊ฒ์ด ์๋ ์๋ํฐ๋ฅผ ์ด์ฉํด ๋ชจ๋ฐ์ผ๋ก ์์ฑํ๋ ๊ฒ์ ์ฝ์ง ์์ต๋๋ค. ํ์ง๋ง ๋งํฌ๋ค์ด์ ์ด์ฉํ๋ฉด ๋ชจ๋ฐ์ผ์์๋ ํ๊ทธ๋ก ์ฝ๊ฒ ์์์ ๋ฃ์ ์ ์์ด์, ์๋ํฐ๋ณด๋ค ํจ์ฌ ํธํฉ๋๋ค.
Markdown Cons ๋งํฌ๋ค์ด ๋จ์
- ๋ฌธ๋ฒ์ด ๋๋ฌด ๋จ์ํ๋ค. ๋ฌธ๋ฒ์ด ๋จ์ํ ๋๋จธ์ง ๊ฒฐ๊ตญ์๋ HTML์ ์จ์ผํ๋ ๊ฒฝ์ฐ๊ฐ ์๊น๋๋ค. ํ ์ด๋ธ ์ ๋ ฌ ๊ธฐ๋ฅ์ ์์ง๋ง, ์ด๋ฏธ์ง ์ ๋ ฌ ๊ธฐ๋ฅ์ด ์์ด์ HTML์ img ํ๊ทธ๋ฅผ ์ฌ์ฉํด์ผํฉ๋๋ค. ํ๊ทธ์ ํด๋์ค ์ง์ ๋ฑ์ด ๋ถ๊ฐ๋ฅํ๊ธฐ ๋๋ฌธ์, ํด๋์ค๋ id๋ฅผ ์ง์ ํ๋ ค๋ฉด HTML์ ์ฌ์ฉํด์ผํฉ๋๋ค.
- ํ์ค์ด ์์ด ์ฌ์ฉ์๋ง๋ค ๋ฌธ๋ฒ์ด ์์ดํ ์ ์๋ค. ๋ฌธ๋ฒ์ด ๋จ์ํ๋ค ๋ณด๋, ์ด๋ฌํ ์ ์ ํด๊ฒฐํ๊ธฐ ์ํด ํ์ฅ๋ฌธ๋ฒ๋ค์ด ์๊ฒผ๊ณ , ์ด๋ฌํ ๊ฒ๋ค ๋๋ฌธ์ ํ ๊ณณ์์ ์๋ํ๋ ๋งํฌ๋ค์ด ๋ฌธ์๊ฐ ๋ค๋ฅธ ๊ณณ์์๋ ์ ์๋ํ์ง ์๋ ๊ฒฝ์ฐ๊ฐ ์๊ธฐ๊ธฐ๋ ํฉ๋๋ค.
Markdown Elements
Table of contents ๋ชฉ์ฐจ
1. Headers ํค๋
2. Emphasis ๊ฐ์กฐ
3. Blockquotes ์ธ์ฉ
4. Lists ๋ชฉ๋ก
5. Backslash Escapes ๋ฐฑ์ฌ๋์ฌ ์ด์ค์ผ์ดํ
6. Images ์ด๋ฏธ์ง
7. Links (Anchor) ๋งํฌ
8. Fenced Code Blocks ์ฝ๋ ๋ธ๋ญ
9. Task Lisk ์ฒดํฌ ๋ฆฌ์คํธ
10. Horizontal Rules ์ํ์
11. Emoji ์ด๋ชจํฐ์ฝ
12. Table ํ
์ด๋ธ
13. Line Breaks ์ค๋ฐ๊ฟ
14. Reference ์ฐธ๊ณ ๋งํฌ
1. Headers ํค๋
- #์ผ๋ก ์์ํ๋ ํ ์คํธ.
- #์ ํ๋๋ถํฐ ์ฌ์ฏ๊ฐ๊น์ง ๊ฐ๋ฅ.
- #์ด ๋์ด๋ ๋๋ง๋ค ์ ๋ชฉ์ ์ค์ผ์ผ ๋ฎ์์ง๋๋ค.
- H1์ ===๋ก๋ ๋ง๋ค ์ ์์ต๋๋ค.
- H2๋ ---๋ก๋ ๋ง๋ค ์ ์์ต๋๋ค.
Syntax ๋งํฌ๋ค์ด ์ฌ์ฉ๋ฒ
This is an H1 === This is an H2 --- # This is an H1 ## This is an H2 ### This is an H3 #### This is an H4 ##### This is an H5 ###### This is an H6
Demonstration ์คํ๊ฒฐ๊ณผ
This is an H1
This is an H2
This is an H1; ๋ถ(parts)์ ์ฌ์ฉ
This is an H2; ์ฅ(chapters)์ ์ฌ์ฉ
This is an H3; ํ์ด์ง ์น์ ์ ์ฌ์ฉ
This is an H5; ํ์ ์น์
์๋์ ํ์ ์น์
์ ์ฌ์ฉ
This is an H6; ๋ฌธ๋จ์ ์ฌ์ฉ
2. Emphasis ๊ฐ์กฐ
- ๊ธฐ์ธ์ฌ ์ฐ๊ธฐ(italic) : * ๋๋ _๋ก ๊ฐ์ผ ํ ์คํธ.
- ๋๊ป๊ฒ ์ฐ๊ธฐ(bold) : ** ๋๋ __๋ก ๊ฐ์ผ ํ ์คํธ.
- ์ทจ์์ : ~~๋ก ๊ฐ์ผ ํ ์คํธ.
- ์ดํค๋ฆญ์ฒด์ ๋๊ป๊ฒ๋ฅผ ๊ฐ์ด ์ฌ์ฉํ ์ ์์ต๋๋ค.
Syntax ๋งํฌ๋ค์ด ์ฌ์ฉ๋ฒ
*This text will be italic* _This will also be italic_ **This text will be bold** __This will also be bold__ ~~This is canceled~~ *You **can** combine them*
Demonstration ์คํ๊ฒฐ๊ณผ
This text will be italic
This will also be italic
This text will be bold
This will also be boldThis is canceled
You can combine them
3. Blockquotes ์ธ์ฉ
- >์ผ๋ก ์์ํ๋ ํ ์คํธ.
- >๋ 3๊ฐ๊น์ง ๊ฐ๋ฅํฉ๋๋ค.
- 1๊ฐ๋ ์ธ์ฉ๋ฌธ.
- 2๊ฐ๋ ์ธ์ฉ๋ฌธ ์์ ์ธ์ฉ๋ฌธ.
- 3๊ฐ๋ ์ธ์ฉ๋ฌธ ์์ ์ธ์ฉ๋ฌธ ์์ ์ธ์ฉ๋ฌธ.
Syntax ๋งํฌ๋ค์ด ์ฌ์ฉ๋ฒ
As Grace Hopper said: > I’ve always been more interested in the future than in the past. > This is a first blockquote. > > This is a second blockquote. > > > This is a third blockquote.
Demonstration ์คํ๊ฒฐ๊ณผ
As Grace Hopper said:
I’ve always been more interested in the future than in the past. This is a first blockquote.
This is a second blockquote.
This is a third blockquote.
4. Lists ๋ชฉ๋ก
4.1. Unordered lists ์์๊ฐ ์๋ ๋ชฉ๋ก
- *, +, - ๋ฅผ ์ด์ฉํด์ ์์๊ฐ ์๋ ๋ชฉ๋ก์ ๋ง๋ค ์ ์์ต๋๋ค.
- ๋ค์ฌ์ฐ๊ธฐ๋ฅผ ํ๋ฉด ๋ชจ์์ด ๋ฐ๋๋๋ค.
4.2. Ordered lists ์์๊ฐ ์๋ ๋ชฉ๋ก
- ์ซ์๋ฅผ ๊ธฐ์ ํ๋ฉด ์์๊ฐ ์๋ ๋ชฉ๋ก์ด ๋ฉ๋๋ค.
- ๋ค์ฌ์ฐ๊ธฐ๋ฅผ ํ๋ฉด ๋ชจ์์ด ๋ฐ๋๋๋ค.
Syntax ๋งํฌ๋ค์ด ์ฌ์ฉ๋ฒ
* Item 1 * Item 2 * Item 1 * Item 2 * Item 1 * Item 2 1. Item 1 2. Item 2 3. Item 3 1. Item 1 2. Item 2 3. Item 3 1. Item 1 2. Item 2 3. Item 3
Demonstration ์คํ๊ฒฐ๊ณผ
- Item 1
- Item 2
- Item 1
- Item 2
- Item 1
- Item 2
- Item 1
- Item 2
- Item 3
- Item 1
- Item 2
- Item 3
- Item 1
- Item 2
- Item
- 5. Backslash Escapes ๋ฐฑ์ฌ๋์ฌ ์ด์ค์ผ์ดํ
- ํน์๋ฌธ์๋ฅผ ํํํ ๋, ํ์๋ ๋ฌธ์ ์์ \๋ฅผ ๋ฃ๊ณ ํน์๋ฌธ์๋ฅผ ์ฐ๋ฉด ๋ฉ๋๋ค.
- ์ฃผ์ํ ์ ์ ์๊ณผ ๋ค์๊ฐ ํ์์ด ๋๊ฐ์ด ๋ฐฑ์ฌ๋์ฌ ๋ค์ ํน์๋ฌธ์์ ๋๋ค. ๊ฐ์ธ๋ ํํ๊ฐ ์๋๋๋ค.
- ๋ฐฑ์ฌ๋์ฌ๋ ์๋์ ํน์๋ฌธ์๋ฅผ ํํํ ์ ์์ต๋๋ค.
- \ backslash, \ backtick, * asterisk, _ underscore, {} curly braces, [] square brackets, () parentheses, # hash mark, + plus sign, - minus sign (hyphen), . dot, ! exclamation mark
- *literal asterisks*
#hash mark#
[squre brackets] - \*literal asterisks\* \#hash mark\# \[squre brackets\]
'๐ ๊น๊ณผ ๊น ํ๋ธ Git & GitHub' ์นดํ ๊ณ ๋ฆฌ์ ๋ค๋ฅธ ๊ธ
Commit๊ณผ Push์ ์ฐจ์ด์ (0) | 2021.06.30 |
---|---|
[๊ฐ๋จ] ๊นํ๋ธ ์๊ฒฉ์ ์ฅ์ ๋ณ๊ฒฝํ๋ ๋ฒ (0) | 2021.06.28 |
๋๊ธ