๋ณธ๋ฌธ ๋ฐ”๋กœ๊ฐ€๊ธฐ
Git ๊ด€๋ จ

[MarkDown] : README.md ํŒŒ์ผ ์ž‘์„ฑ์„ ์œ„ํ•œ ๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ• ์ •๋ฆฌ.

by ๊ถŒ์Šพํ–„ 2023. 6. 17.

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

์ผ๋ฐ˜ ํ…์ŠคํŠธ ํŒŒ์ผ์— ์„œ์‹์„ ์ถ”๊ฐ€ํ•ด์ฃผ๊ธฐ ์œ„ํ•ด์„œ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•œ ๋งˆํฌ์—… ์–ธ์–ด์˜ ํ•œ ์ข…๋ฅ˜๋ผ๊ณ  ํ•œ๋‹ค.

๋งˆํฌ์—… ์–ธ์–ด๋ž€?

ํƒœ๊ทธ ๋“ฑ์„ ์ด์šฉํ•˜์—ฌ ๋ฌธ์„œ๋‚˜ ๋ฐ์ดํ„ฐ์˜ ๊ตฌ์กฐ๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” ์–ธ์–ด์˜ ํ•œ ๊ฐ€์ง€.

์‰ฝ๊ฒŒ ์ƒ๊ฐํ•ด HTML์˜ ํƒœ๊ทธ๋“ค์„ ์ƒ๊ฐํ•ด์ฃผ๋ฉด ๋  ๊ฒƒ ๊ฐ™๋‹ค.


๋งˆํฌ๋‹ค์šด์œผ๋กœ '์ œ๋ชฉ' ์„ค์ •ํ•˜๊ธฐ.
๋งˆํฌ๋‹ค์šด HTML
# ์ œ๋ชฉ <h1> ์ œ๋ชฉ </h1>
## ์ œ๋ชฉ <h2> ์ œ๋ชฉ </h2>
### ์ œ๋ชฉ <h3> ์ œ๋ชฉ </h3>
#### ์ œ๋ชฉ <h4> ์ œ๋ชฉ </h4>
##### ์ œ๋ชฉ <h5> ์ œ๋ชฉ </h5>
###### ์ œ๋ชฉ <h6> ์ œ๋ชฉ </h6>

์ œ๋ชฉ์€ h1 ๋ถ€ํ„ฐ h6 ๊นŒ์ง€ ๋ช…์‹œ์ ์œผ๋กœ ํ‘œ๊ธฐ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค.

# ์œผ๋กœ ์ œ๋ชฉ์˜ ์‚ฌ์ด์ฆˆ๋ฅผ ํ‘œํ˜„ํ–ˆ๋‹ค๋ฉด, ํ•œ ์นธ์„ ๋„์›Œ์ฃผ๊ณ  ํƒ€์ดํ•‘์„ ํ•ด์ค˜์•ผ ํ•œ๋‹ค.

๊ทธ๋ฆฌ๊ณ  ์ œ๋ชฉ์˜ ์•ž์ค„๊ณผ ๋’ท์ค„์—๋Š” blank line์œผ๋กœ ํ‘œ์‹œ๋ฅผ ํ•ด์ฃผ์–ด์•ผ ํ˜ธํ™˜์ด ๊ฐ€๋Šฅํ•˜๋‹ค.

 


๋‹จ๋ฝ ํ‘œ์‹œ
๋งˆํฌ๋‹ค์šด HTML
"blank line" <p> pํƒœ๊ทธ </p>
์˜ˆ์‹œ)

Hello MarkDown

Thank you

<p> Hello MarkDown </p>
<p> Thank you </p>

์ค„๋ฐ”๊ฟˆ
๋งˆํฌ๋‹ค์šด HTML
๋‘ ์นธ ์ด์ƒ์˜ ๊ณต๋ฐฑ <p> pํƒœ๊ทธ ์‚ฌ์ด์˜ <br>
brํƒœ๊ทธ </p>

๊ฐ•์กฐ
๋งˆํฌ๋‹ค์šด HTML
**์˜ˆ์‹œ**
__์˜ˆ์‹œ__
<strong>์˜ˆ์‹œ</strong>

๊ฐ•์กฐํ•˜๊ณ ์ž ํ•˜๋Š” ๊ธ€์ž์˜ ์•ž ๋’ค์— ๊ณต๋ฐฑ์ด ์—†์ด ** ๋˜๋Š” __ ๋ฅผ ๋ถ™์—ฌ์ค˜์•ผ ํ•œ๋‹ค.


๊ธฐ์šธ์ž„
๋งˆํฌ๋‹ค์šด HTML
*์˜ˆ์‹œ*
_์˜ˆ์‹œ_
<em>์˜ˆ์‹œ</em>

๊ธฐ์šธ์ž„์ฒด๋„ ๋งˆ์ฐฌ๊ฐ€์ง€๊ณ  ๊ธฐ์šธ์ด๊ณ ์ž ํ•˜๋Š” ๋ฌธ์ž์˜ ์•ž ๋’ค์— ๊ณต๋ฐฑ์—†์ด * ๋˜๋Š” _ ๋ฅผ ๋ถ™์—ฌ์ค˜์•ผ ํ•œ๋‹ค.


๊ธฐ์šธ์ž„ ๊ฐ•์กฐ
๋งˆํฌ๋‹ค์šด HTML
***์˜ˆ์‹œ***
___์˜ˆ์‹œ___
<em><strong>์˜ˆ์‹œ</strong></em>

์œ„์˜ ๊ฐ•์กฐ์™€ ๊ธฐ์šธ์ž„์˜ ๋ณ„ํ‘œ ๋˜๋Š” ์–ธ๋”๋ฐ” ๊ฐœ์ˆ˜๋งŒํผ ํ•ฉ์ณ์ฃผ๋ฉด ๊ธฐ์šธ์ž„ ๊ฐ•์กฐ ํ‘œํ˜„์ด ๊ฐ€๋Šฅํ•˜๋‹ค.


์ธ์šฉ๊ตฌ

 

1) ๋ฒ„ํ‹ฐ์ปฌ ๋ผ์ธ

๋„ค์ด๋ฒ„ ๋ธ”๋กœ๊ทธ์˜ "๋ฒ„ํ‹ฐ์ปฌ ๋ผ์ธ"์„ ๋งˆํฌ๋‹ค์šด์—์„œ๋Š” ๊ฐ„ํŽธํ•˜๊ฒŒ ์‹คํ˜„์‹œํ‚ฌ ์ˆ˜ ์žˆ๋‹ค.

๋งˆํฌ๋‹ค์šด ๋งˆํฌ๋‹ค์šด
> ์ด๋ ‡๊ฒŒ ํ‘œํ˜„ ๊ฐ€๋Šฅ. > ์ด๋Ÿฐ์‹์œผ๋กœ
> ๊ด‘๋ฒ”์œ„ํ•˜๊ฒŒ
> ํ‘œํ˜„๋„๊ฐ€๋Šฅ

 

1-1) ๋ฒ„ํ‹ฐ์ปฌ ๋ผ์ธ ์ถ”๊ฐ€

์ถ”๊ฐ€ ์ ์œผ๋กœ ๋ฒ„ํ‹ฐ์ปฌ๋ผ์ธ ์•ˆ์— ๋ฒ„ํ‹ฐ์ปฌ๋ผ์ธ๋„ ์ถ”๊ฐ€๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค.

๋งˆํฌ๋‹ค์šด
> ์—ฌ๊ธฐ ์•ˆ์—
>> ์ด๋ ‡๊ฒŒ ๋ฒ„ํ‹ฐ์ปฌ๋ผ์ธ ์ถ”๊ฐ€๊ฐ€ ๊ฐ€๋Šฅ

 

1-2) ๋ฒ„ํ‹ฐ์ปฌ ๋ผ์ธ ์•ˆ์˜ ๋‹ค๋ฅธ ์ธ์šฉ๊ตฌ

-๋ฅผ ์‚ฌ์šฉํ•ด์„œ '๋ชฉ๋ก'ํ˜•์‹์œผ๋กœ ํ‘œํ˜„๋„ ๊ฐ€๋Šฅ.

๋ฒ„ํ‹ฐ์ปฌ ๋ผ์ธ ์•ˆ์—์„œ ์ œ๋ชฉ ํ‘œ์‹œ ๋˜๋Š” ๊ธฐ์šธ์ž„, ๋ณผ๋“œ์ฒด ์ „๋ถ€ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•˜๋‹ค.

๋งˆํฌ๋‹ค์šด
> #### ์ œ๋ชฉ์„ค์ • >
> - ๋ชฉ๋กํ˜•์‹
> - ์š”๋Ÿฐ์‹์œผ๋กœ "-" ๋ฅผ ์‚ฌ์šฉ
> > *๊ธฐ์šธ์ž„*๊ณผ **๊ฐ•์กฐ**๋„ ์‚ฌ์šฉ์ด ๊ฐ€๋Šฅํ•˜๋‹ค.

2) ๋ชฉ๋ก

๋งˆํฌ๋‹ค์šด
+ ๋˜๋Š” - ๋˜๋Š” * ์„ ์ด์šฉํ•˜์—ฌ ๋ชฉ๋ก ์ž‘์„ฑ ๊ฐ€๋Šฅ,

์ˆœ์„œ๋ฅผ ์ฃผ๊ณ  ์‹ถ๋‹ค๋ฉด
  1. ์ด๋ ‡๊ฒŒ
  2. ์ž‘์„ฑ์„
  3. ํ•ด์ฃผ๋ฉด ๋œ๋‹ค.

๋˜ํ•œ ๋ชฉ๋ก์„ ํ‘œ์‹œ ํ•˜๋ฉด์„œ
"-"๋กœ ์‹œ์ž‘ํ–ˆ๋‹ค๋ฉด, ๊ณ„์† "-"๋กœ ํ‘œ์‹œ ํ•ด์•ผํ•จ.
(-์™€ +๋ฅผ ์„ž์–ด์„œ ๋ชฉ๋กํ‘œ์‹œํ•˜๋ฉด ์•ˆ๋จ.)

์ฝ”๋“œ ๋ธ”๋ก

4๊ฐœ์˜ ๊ณต๋ฐฑ ๋˜๋Š” 1ํƒญ์˜ ๋“ค์—ฌ์“ฐ๊ธฐ๋กœ ์ฝ”๋“œ๋ธ”๋ก ์ž‘์„ฑ ๊ฐ€๋Šฅ

๋‹จ, ๋ชฉ๋ก ์•ˆ์—์„œ ์ฝ”๋“œ๋ธ”๋ก์„ ์ž‘์„ฑํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด 8๊ฐœ์˜ ๊ณต๋ฐฑ ๋˜๋Š” 2ํƒญ์œผ๋กœ ์ฝ”๋“œ๋ธ”๋ก ์ž‘์„ฑ์ด ๊ฐ€๋Šฅํ•˜๋‹ค.


๋งํฌ

1) ๋งํฌ ๋˜๋Š” email

๋งˆํฌ๋‹ค์šด
<https://github.com/Yooonzero/3-personal-assignment-create-backend-server/blob/main/README.md>
<playlist808@kakao.com>
์œ„์™€ ๊ฐ™์ด ๊บฝ์‡ ๋ฅผ ์ด์šฉํ•˜์—ฌ ํ‘œ์‹œํ•œ๋‹ค

2) ๋‹จ์–ด์™€ ๋‹จ์–ด ์‚ฌ์ด์— ๋งํฌ๋ฅผ ๋„ฃ์–ด์ฃผ๊ณ  ์‹ถ๋‹ค๋ฉด

๋งˆํฌ๋‹ค์šด
๊ธ€์„ ์ž‘์„ฑํ•˜๋‹ค ๊ธ€ ์‚ฌ์ด์— ๋งํฌ๋ฅผ ๋‹ฌ์•„์ฃผ๊ณ  ์‹ถ๋‹ค๋ฉด [์—ฌ๊ธฐ์— ๋งํฌ ํ…์ŠคํŠธ๋ฅผ ์จ์ฃผ๊ณ ](์—ฌ๊ธฐ์— ๋งํฌ URL์„ ๋„ฃ์–ด์ค€๋‹ค.)
์ž‘์„ฑํ•œ ๋งํฌ์— ์ œ๋ชฉ์„ ๋ถ™์—ฌ์ฃผ๊ณ  ์‹ถ๋‹ค๋ฉด(๋งํฌ URL ๋’ค์— "์—ฌ๊ธฐ์— ์ œ๋ชฉ์„ ์ž‘์„ฑ")

๋งํฌ๋ฅผ ๋ณผ๋“œ์ฒด ๋˜๋Š” ๊ธฐ์šธ๊ธฐ๋กœ ํ‘œํ˜„๋„ ๊ฐ€๋Šฅํ•˜๋‹ค.


์ด๋ฏธ์ง€ ์ถ”๊ฐ€
๋งˆํฌ๋‹ค์šด
! [๋А๋‚Œํ‘œ๋กœ ์‹œ์ž‘ํ•˜๊ณ  ์—ฌ๊ธฐ์— ๋Œ€์ฒด ํ…์ŠคํŠธ](์—ฌ๊ธฐ์— ์ด๋ฏธ์ง€์˜ ๊ฒฝ๋กœ ๋ฐ URL ์ฃผ์†Œ๋ฅผ ์ž…๋ ฅ "๋˜‘๊ฐ™์ด ์—ฌ๊ธฐ์— ์ œ๋ชฉ ํ‘œ์‹œ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค.")

 

์ด๋ฏธ์ง€๋กœ ๋งํฌ๋ฅผ ์ถ”๊ฐ€ํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด

์ด๋ฏธ์ง€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” markdown ์ „์ฒด๋ฅผ [] ๋Œ€๊ด„ํ˜ธ๋กœ ๋ฌถ์–ด์ฃผ๊ณ  ๋’ค์— (URL ์ฃผ์†Œ)๋ฅผ ์ถ”๊ฐ€ ํ•ด์ค€๋‹ค.

๋งˆํฌ๋‹ค์šด
[! [๋А๋‚Œํ‘œ๋กœ ์‹œ์ž‘ํ•˜๊ณ  ์—ฌ๊ธฐ์— ๋Œ€์ฒด ํ…์ŠคํŠธ](์—ฌ๊ธฐ์— ์ด๋ฏธ์ง€์˜ ๊ฒฝ๋กœ ๋ฐ URL ์ฃผ์†Œ๋ฅผ ์ž…๋ ฅ "๋˜‘๊ฐ™์ด ์—ฌ๊ธฐ์— ์ œ๋ชฉ ํ‘œ์‹œ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค.")](์—ฌ๊ธฐ์— ํ•ด๋‹น ์ด๋ฏธ์ง€์˜ URL ์ถ”๊ฐ€)

 

#README์‚ฌ์šฉ์„_์œ„ํ•ด_๋งˆํฌ๋‹ค์šด_๊ณต๋ถ€

#๊ฐ„ํŽธํ•ด์„œ

#์ข‹๋‹ค

#๋นจ๋ฆฌ

#README

#์ž‘์„ฑํ•ด๋ณด๊ณ _์‹ถ์Œ