Skip to content

Latest commit

ย 

History

History
150 lines (117 loc) ยท 4.33 KB

How_to_Write_with_Markdown.md

File metadata and controls

150 lines (117 loc) ยท 4.33 KB

๋งˆํฌ๋‹ค์šด Markdown ์ž‘์„ฑ ๋ฐฉ๋ฒ•

1. ๋งˆํฌ๋‹ค์šด?

1.1. ๋งˆํฌ๋‹ค์šด์ด๋ž€?

๋งˆํฌ๋‹ค์šด(Markdown)์€ ์ผ๋ฐ˜ ํ…์ŠคํŠธ ๊ธฐ๋ฐ˜์˜ ๊ฒฝ๋Ÿ‰ ๋งˆํฌ์—… ์–ธ์–ด๋‹ค. ์ผ๋ฐ˜ ํ…์ŠคํŠธ๋กœ ์„œ์‹์ด ์žˆ๋Š” ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•˜๋Š” ๋ฐ ์‚ฌ์šฉ๋˜๋ฉฐ, ์ผ๋ฐ˜ ๋งˆํฌ์—… ์–ธ์–ด์— ๋น„ํ•ด ๋ฌธ๋ฒ•์ด ์‰ฝ๊ณ  ๊ฐ„๋‹จํ•œ ๊ฒƒ์ด ํŠน์ง•์ด๋‹ค. HTML๊ณผ ๋ฆฌ์น˜ ํ…์ŠคํŠธ(RTF) ๋“ฑ ์„œ์‹ ๋ฌธ์„œ๋กœ ์‰ฝ๊ฒŒ ๋ณ€ํ™˜๋˜๊ธฐ ๋•Œ๋ฌธ์— ์‘์šฉ ์†Œํ”„ํŠธ์›จ์–ด์™€ ํ•จ๊ป˜ ๋ฐฐํฌ๋˜๋Š” README ํŒŒ์ผ์ด๋‚˜ ์˜จ๋ผ์ธ ๊ฒŒ์‹œ๋ฌผ ๋“ฑ์— ๋งŽ์ด ์‚ฌ์šฉ๋œ๋‹ค. Wikipedia

ํŒŒ์ผ ํ™•์žฅ์ž๊ฐ€ .md ๋กœ ๋œ ํŒŒ์ผ๋“ค, ์˜ˆ๋ฅผ ๋“ค๋ฉด README.md ํŒŒ์ผ์ด ๋ฐ”๋กœ ๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ•์œผ๋กœ ์ž‘์„ฑ๋œ ๋ฌธ์„œ์ด๋‹ค.

1.2. ๋งˆํฌ๋‹ค์šด์„ ์‚ฌ์šฉํ•˜๋Š” ์ด์œ 

๋งˆํฌ๋‹ค์šด์€ ์•„๋ž˜์™€ ๊ฐ™์€ ์žฅ์ ์ด ์žˆ๋‹ค.

  • ๋ฌธ๋ฒ•์ด ๋‹จ์ˆœํ•ด์„œ ์‚ฌ์šฉํ•˜๊ธฐ ์‰ฝ๋‹ค.
  • ์ˆœ์ˆ˜ํ•œ ํ…์ŠคํŠธ์ด๊ธฐ์— ์–ด๋””์„œ๋‚˜ ํŽธ์ง‘์ด ๊ฐ€๋Šฅํ•˜๊ณ  ์–ด๋””์„œ๋‚˜ ๋ณผ ์ˆ˜ ์žˆ๋‹ค.
  • html๋กœ ๋ณ€ํ™˜๋˜์ง€๋งŒ, ํƒœ๊ทธ ๋˜๋Š” ์„œ์‹์œผ๋กœ ํ‘œ์‹œ๋œ ๊ฒƒ์ฒ˜๋Ÿผ ๋ณด์ด์ง€ ์•Š์•„์„œ ๊ทธ ์ž์ฒด๋งŒ์œผ๋กœ๋„ ์ฝ๊ธฐ ์‰ฝ๋‹ค.
  • ...

๊ทธ๋Ÿฌ๋‚˜ ๋งˆํฌ๋‹ค์šด์€ ํ‘œ์ค€์ด ์˜ค๋ž˜๋˜๊ณ  ์ƒˆ๋กœ ๋‚˜์˜ค์ง€ ์•Š์•„์„œ ๊ทธ๋ฆผ ์‚ฝ์ž… ๋“ฑ ๊ฒฐ๊ตญ HTML์„ ์‚ฌ์šฉํ•ด์•ผ ํ•˜๋Š” ๊ฒฝ์šฐ๊ฐ€ ์ƒ๊ธธ ์ˆ˜ ์žˆ๋‹ค.

๊ทธ๋ž˜์„œ์ธ์ง€ GitHub Flavored Markdown ๋“ฑ ์—ฌ๋Ÿฌ ํ™•์žฅ ๋ฌธ๋ฒ•์ด ๋‚˜ํƒ€๋‚ฌ๋‹ค.

2. ๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ• Syntax

๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ• ์ฐธ๊ณ  ์‚ฌ์ดํŠธ

ํ—ค๋” (Headers)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

h7 ๋ถ€ํ„ฐ๋Š” ์—†๋‹ค.

This is an <h1> tag

This is an <h2> tag

This is an <h6> tag

๊ฐ•์กฐ (Emphasis)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
์ดํƒค๋ฆญ์ฒด(* , _)
*This text will be italic*
_This will also be italic_

๋ณผ๋“œ์ฒด(** , __)
**This text will be bold**
__This will also be bold__

์ดํƒค๋ฆญ์ฒด, ๋ณผ๋“œ์ฒด ํ•จ๊ป˜ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•
_You **can** combine them_

This text will be italic This will also be italic

This text will be bold This will also be bold

You can combine them

๋ฆฌ์ŠคํŠธ (Lists)

๋ฒˆํ˜ธ ์—†๋Š” ๋ฆฌ์ŠคํŠธ (Unordered)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
* Item 1
* Item 2
    * Item 2a
    * Item 2b
  • Item 1
  • Item 2
    • Item 2a
    • Item 2b

๋ฒˆํ˜ธ ์žˆ๋Š” ๋ฆฌ์ŠคํŠธ (Ordered)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
1. Item 1
1. Item 2
1. Item 3
    1. Item 3a
    1. Item 3b

[1. 2. 3.] ์œผ๋กœ ์ ์–ด๋„,
[2. 1. 3.] ์œผ๋กœ ์ ๋”๋ผ๋„ ์œ„์—์„œ๋ถ€ํ„ฐ ์•„๋ž˜๋กœ ์ˆœ์„œ๋Œ€๋กœ [1. 2. 3.] ์œผ๋กœ ์ž๋™์œผ๋กœ ๋ฐ”๋€๋‹ค.
  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

์ด๋ฏธ์ง€ (Images)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)

Format: ![Alt Text](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)

GitHub Logo

๋งํฌ (Links)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
http://github.com - automatic!
[GitHub](http://github.com)

์ผ๋ฐ˜ ๋งํฌ๋Š” ์ž๋™์œผ๋กœ ํ•˜์ดํผ๋งํฌ๋กœ ์ ์šฉ๋œ๋‹ค.
[]() ๋Š” []์•ˆ์˜ ๋ฌธ์ž๋กœ ()์•ˆ์˜ ๋งํฌ๊ฐ€ ํ•˜์ดํผ๋งํฌ ์ ์šฉ๋œ๋‹ค.

http://github.com - automatic!
GitHub

๋ธ”๋ก ์ธ์šฉ (Blockquotes)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
As Kanye West said:

> We're living the future so
> the present is our past.

As Kanye West said:

We're living the future so the present is our past.

์ธ๋ผ์ธ ์ฝ”๋“œ (Inline code)

<์ž‘์„ฑ ๋ฐฉ๋ฒ•>
I think you should use an
`<addr>` element here instead.

๋ผ์ธ ์•ˆ์— ์ฝ”๋“œ๋ฅผ ์‚ฝ์ž…ํ•˜์—ฌ ๋ณด์—ฌ์ค€๋‹ค.

I think you should use an <addr> element here instead.

์ฐธ๊ณ  ์ž๋ฃŒ