Skip to main content

์ฝ”๋“œ ์กฐ๊ฐ์— ๋Œ€ํ•œ ๊ณ ์ • ๋งํฌ ๋งŒ๋“ค๊ธฐ

ํŒŒ์ผ ๋˜๋Š” ๋Œ์–ด์˜ค๊ธฐ ์š”์ฒญ์˜ ํŠน์ • ๋ฒ„์ „์—์„œ ํŠน์ • ์ค„ ๋˜๋Š” ์ฝ”๋“œ ์ค„ ๋ฒ”์œ„์— ๋Œ€ํ•œ ์˜๊ตฌ ๋งํฌ๋ฅผ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋ˆ„๊ฐ€ ์ด ๊ธฐ๋Šฅ์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‚˜์š”?

Markdown์€ GitHub ์›น ์ธํ„ฐํŽ˜์ด์Šค์—์„œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์ฝ”๋“œ์— ์—ฐ๊ฒฐ

์ด ์œ ํ˜•์˜ ๊ณ ์ • ๋งํฌ๋Š” ์›๋ž˜ ์ถœ์ฒ˜์ธ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ์—์„œ๋งŒ ์ฝ”๋“œ ์กฐ๊ฐ์œผ๋กœ ๋ Œ๋”๋ง๋ฉ๋‹ˆ๋‹ค. ๋‹ค๋ฅธ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ์—์„œ ๊ณ ์ • ๋งํฌ ์ฝ”๋“œ ์กฐ๊ฐ์€ URL๋กœ ๋ Œ๋”๋ง๋ฉ๋‹ˆ๋‹ค. ์ด๋Š” Markdown ํŒŒ์ผ์—์„œ๋งŒ ์ž‘๋™ํ•˜์ง€ ์•Š์œผ๋ฉฐ ์ฃผ์„์—์„œ๋งŒ ์ž‘๋™ํ•ฉ๋‹ˆ๋‹ค.

์ด์Šˆ ๋ฉ”๋ชจ์˜ ์Šคํฌ๋ฆฐ์ƒท ์ฝ”๋“œ ์กฐ๊ฐ์—๋Š” ํŒŒ์ผ ์ด๋ฆ„ ๋ฐ ์ค„ ๋ฒˆํ˜ธ๋ฅผ ๋‚˜์—ดํ•˜๋Š” ํ—ค๋”์™€ ํ•ด๋‹น ์ค„์˜ ์ฝ”๋“œ๋ฅผ ๋‚˜์—ดํ•˜๋Š” ๋ณธ๋ฌธ์ด ์žˆ์Šต๋‹ˆ๋‹ค.

ํŒ

์ „์ฒด ํŒŒ์ผ์— ๋Œ€ํ•œ ๊ณ ์œ  ๋งํฌ๋ฅผ ๋งŒ๋“ค๋ ค๋ฉด ํŒŒ์ผ์— ๋Œ€ํ•œ ์˜๊ตฌ ๋งํฌ ๊ฐ€์ ธ์˜ค๊ธฐ์„(๋ฅผ) ์ฐธ์กฐํ•˜์„ธ์š”.

  1. GitHub์—์„œ ๋ฆฌํฌ์ง€ํ† ๋ฆฌ์˜ ๊ธฐ๋ณธ ํŽ˜์ด์ง€๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.

  2. ์—ฐ๊ฒฐํ•  ์ฝ”๋“œ๋ฅผ ์ฐพ์Šต๋‹ˆ๋‹ค.

    • ํŒŒ์ผ์—์„œ ์ฝ”๋“œ์— ์—ฐ๊ฒฐํ•˜๋ ค๋ฉด ํ•ด๋‹น ํŒŒ์ผ๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.
    • ๋Œ์–ด์˜ค๊ธฐ ์š”์ฒญ์—์„œ ์ฝ”๋“œ์— ์—ฐ๊ฒฐํ•˜๋ ค๋ฉด ๋Œ์–ด์˜ค๊ธฐ ์š”์ฒญ์œผ๋กœ ์ด๋™ํ•˜๊ณ  Files changed๋ฅผ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋Ÿฐ ๋‹ค์Œ ์ฃผ์„์— ํฌํ•จํ•  ์ฝ”๋“œ๊ฐ€ ํฌํ•จ๋œ ํŒŒ์ผ์„ ์ฐพ์•„ View๋ฅผ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค.
  3. ํ•œ ์ค„ ๋˜๋Š” ๋ฒ”์œ„๋ฅผ ์„ ํƒํ• ์ง€ ์—ฌ๋ถ€๋ฅผ ์„ ํƒํ•ฉ๋‹ˆ๋‹ค.

    • ํ•œ ์ค„์˜ ์ฝ”๋“œ๋ฅผ ์„ ํƒํ•˜๋ ค๋ฉด ์ค„ ๋ฒˆํ˜ธ๋ฅผ ํด๋ฆญํ•˜์—ฌ ์ค„์„ ๊ฐ•์กฐ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.
    • ์ฝ”๋“œ ๋ฒ”์œ„๋ฅผ ์„ ํƒํ•˜๋ ค๋ฉด ๋ฒ”์œ„์˜ ์ฒซ ๋ฒˆ์งธ ์ค„ ์ˆ˜๋ฅผ ํด๋ฆญํ•˜์—ฌ ์ฝ”๋“œ ์ค„์„ ๊ฐ•์กฐ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค. ๊ทธ๋Ÿฐ ๋‹ค์Œ ์ฝ”๋“œ ๋ฒ”์œ„์˜ ๋งˆ์ง€๋ง‰ ์ค„ ์œ„๋กœ ๋งˆ์šฐ์Šค๋ฅผ ๊ฐ€์ ธ๊ฐ€๊ณ  Shift ํ‚ค๋ฅผ ๋ˆ„๋ฅธ ๋‹ค์Œ ์ค„ ๋ฒˆํ˜ธ๋ฅผ ํด๋ฆญํ•˜์—ฌ ๋ฒ”์œ„๋ฅผ ๊ฐ•์กฐ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.
  4. ์ค„์˜ ์™ผ์ชฝ ๋˜๋Š” ์ค„์˜ ๋ฒ”์œ„์—์„œ ์„(๋ฅผ) ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค. ๋“œ๋กญ๋‹ค์šด ๋ฉ”๋‰ด์—์„œ ๊ณ ์ • ๋งํฌ ๋ณต์‚ฌ๋ฅผ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค.

    8์ค„์ด ์„ ํƒ๋œ ํŒŒ์ผ์˜ ์Šคํฌ๋ฆฐ์ƒท ์ฒซ ๋ฒˆ์งธ ์„ ํƒํ•œ ์ค„์˜ ์™ผ์ชฝ์— ์ผ€๋ฐฅ ์•„์ด์ฝ˜์œผ๋กœ ๋ ˆ์ด๋ธ”์ด ์ง€์ •๋œ ๋‹จ์ถ”๊ฐ€ ์ง„ํ•œ ์ฃผํ™ฉ์ƒ‰ ์œค๊ณฝ์„ ์œผ๋กœ ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค.

  5. ์ฝ”๋“œ ์กฐ๊ฐ์— ์—ฐ๊ฒฐํ•˜๋ ค๋Š” ๋Œ€ํ™”๋กœ ์ด๋™ํ•ฉ๋‹ˆ๋‹ค.

  6. ๊ณ ์ • ๋งํฌ๋ฅผ ์ฃผ์„์— ๋ถ™์—ฌ๋„ฃ๊ณ  ์ฃผ์„์„ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค.

Markdown์— ์—ฐ๊ฒฐ

Markdown ๋ Œ๋”๋ง ์—†์ด Markdown ํŒŒ์ผ์„ ๋กœ๋“œํ•˜์—ฌ Markdown ํŒŒ์ผ์˜ ํŠน์ • ์ค„์— ์—ฐ๊ฒฐํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ Œ๋”๋งํ•˜์ง€ ์•Š๊ณ  Markdown ํŒŒ์ผ์„ ๋กœ๋“œํ•˜๋ ค๋ฉด ํŒŒ์ผ์˜ URL ๋์— ์žˆ๋Š” ?plain=1 ๋งค๊ฐœ ๋ณ€์ˆ˜๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์˜ˆ๋“ค ๋“ค์–ด github.com/<organization>/<repository>/blob/<commit_SHA>/README.md?plain=1์ž…๋‹ˆ๋‹ค.

์ฝ”๋“œ์—์„œ์™€ ๋™์ผํ•œ ๋ฐฉ์‹์œผ๋กœ Markdown ํŒŒ์ผ์˜ ํŠน์ • ์ค„์— ์—ฐ๊ฒฐํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. URL ๋์— ์ค„ ๋ฒˆํ˜ธ ๋˜๋Š” ์ˆซ์ž์™€ ํ•จ๊ป˜ #L์„ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ ๋“ค์–ด github.com/<organization>/<repository>/blob/<commit_SHA>/README.md?plain=1#L14๋Š” ์ผ๋ฐ˜ README.md ํŒŒ์ผ์—์„œ ์ค„ 14๋ฅผ ๊ฐ•์กฐ ํ‘œ์‹œํ•ฉ๋‹ˆ๋‹ค.

์ถ”๊ฐ€ ์ฐธ๊ณ  ์ž๋ฃŒ