Skip to main content

์ฝ”๋“œ ๋ธ”๋ก ๋งŒ๋“ค๊ธฐ ๋ฐ ๊ฐ•์กฐ ํ‘œ์‹œ

์šธํƒ€๋ฆฌ์นœ ์ฝ”๋“œ ๋ธ”๋ก๊ณผ ์ฝ”๋“œ ์ƒ˜ํ”Œ์„ ๊ณต์œ ํ•˜๊ณ  ๊ตฌ๋ฌธ ๊ฐ•์กฐ ํ‘œ์‹œ๋ฅผ ์‚ฌ์šฉํ•˜๋„๋ก ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

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

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

ํŽœ์‹ฑ๋œ ์ฝ”๋“œ ๋ธ”๋ก

์ฝ”๋“œ ๋ธ”๋ก ์•ž๋’ค์— ์‚ผ์ค‘ ๋ฐฑํ‹ฑ ```์„ ๋ฐฐ์น˜ํ•˜์—ฌ ํŽœ์‹ฑ๋œ ์ฝ”๋“œ ๋ธ”๋ก์„ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์›์‹œ ์„œ์‹์„ ๋” ์‰ฝ๊ฒŒ ์ฝ์„ ์ˆ˜ ์žˆ๋„๋ก ์ฝ”๋“œ ๋ธ”๋ก ์ „ํ›„์— ๋นˆ ์ค„์„ ๋ฐฐ์น˜ํ•˜๋Š” ๊ฒƒ์ด ์ข‹์Šต๋‹ˆ๋‹ค.

```
function test() {
  console.log("notice the blank line before this function?");
}
```

์ฝ”๋“œ ๋ธ”๋ก์„ ๋งŒ๋“ค๊ธฐ ์œ„ํ•ด ์‚ผ์ค‘ ๋ฐฑํ‹ฑ์„ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์„ ๋ณด์—ฌ ์ฃผ๋Š” ๋ Œ๋”๋ง๋œ GitHub Markdown์˜ ์Šคํฌ๋ฆฐ์ƒท ๋ธ”๋ก์€ "ํ•จ์ˆ˜ ํ…Œ์ŠคํŠธ() {"๋กœ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค.

ํŒ

๋ชฉ๋ก ๋‚ด์—์„œ ์„œ์‹์„ ์œ ์ง€ํ•˜๋ ค๋ฉด ํŽœ์‹ฑ๋˜์ง€ ์•Š์€ ์ฝ”๋“œ ๋ธ”๋ก์„ 8์นธ ๋“ค์—ฌ์จ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

ํŽœ์‹ฑ๋œ ์ฝ”๋“œ ๋ธ”๋ก์— 3์ค‘ ๋ฐฑํ‹ฑ์„ ํ‘œ์‹œํ•˜๋ ค๋ฉด 4์ค‘ ๋ฐฑํ‹ฑ ์•ˆ์— ๋„ฃ์Šต๋‹ˆ๋‹ค.

````
```
Look! You can see my backticks.
```
````

์‚ฌ์ค‘ ๋ฐฑํ‹ฑ ์‚ฌ์ด์— ์‚ผ์ค‘ ๋ฐฑํ‹ฑ์„ ์ž‘์„ฑํ•  ๋•Œ ๋ Œ๋”๋ง๋œ ์ฝ˜ํ…์ธ ์— ํ‘œ์‹œ๋˜๋Š” ๊ฒƒ์„ ๋ณด์—ฌ ์ฃผ๋Š” ๋ Œ๋”๋ง๋œ Markdown์˜ ์Šคํฌ๋ฆฐ์ƒท

์ฝ”๋“œ ์กฐ๊ฐ๊ณผ ํ…Œ์ด๋ธ”์„ ์ž์ฃผ ํŽธ์ง‘ํ•˜๋Š” ๊ฒฝ์šฐ GitHub์˜ ๋ชจ๋“  ์ฃผ์„ ํ•„๋“œ์—์„œ ๊ณ ์ • ๋„ˆ๋น„ ๊ธ€๊ผด์„ ์‚ฌ์šฉํ•˜๋„๋ก ์„ค์ •ํ•˜๋ฉด ๋„์›€์ด ๋  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ GitHub์—์„œ์˜ ์“ฐ๊ธฐ ๋ฐ ์„œ์‹ ์ง€์ • ์ •๋ณด์„(๋ฅผ) ์ฐธ์กฐํ•˜์„ธ์š”.

๊ตฌ๋ฌธ ๊ฐ•์กฐ

์„ ํƒ์  ์–ธ์–ด ์‹๋ณ„์ž๋ฅผ ์ถ”๊ฐ€ํ•˜์—ฌ ํŽœ์‹ฑ๋œ ์ฝ”๋“œ ๋ธ”๋ก์—์„œ ๊ตฌ๋ฌธ์„ ๊ฐ•์กฐํ•˜๋„๋ก ์„ค์ •ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๊ฐ•์กฐ ํ‘œ์‹œ๋œ ๊ตฌ๋ฌธ์€ ์‰ฝ๊ฒŒ ์ฝ์„ ์ˆ˜ ์žˆ๋„๋ก ์†Œ์Šค ์ฝ”๋“œ์˜ ์ƒ‰๊ณผ ์Šคํƒ€์ผ์„ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.

์˜ˆ๋ฅผ ๋“ค์–ด ๊ตฌ๋ฌธ์—์„œ Ruby ์ฝ”๋“œ๋ฅผ ๊ฐ•์กฐ ํ‘œ์‹œํ•˜๋ ค๋ฉด ๋‹ค์Œ์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

๊ทธ๋Ÿฌ๋ฉด ๊ตฌ๋ฌธ์ด ๊ฐ•์กฐ ํ‘œ์‹œ๋œ ์ฝ”๋“œ ๋ธ”๋ก์ด ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค.

GitHub์— ํ‘œ์‹œ๋œ Ruby ์ฝ”๋“œ์˜ ์„ธ ์ค„ ์Šคํฌ๋ฆฐ์ƒท์ž…๋‹ˆ๋‹ค. ์ฝ”๋“œ์˜ ์š”์†Œ๋Š” ์Šค์บ”ํ•˜๊ธฐ ์‰ฝ๋„๋ก ๋ณด๋ผ์ƒ‰, ํŒŒ๋ž€์ƒ‰, ๋นจ๊ฐ„์ƒ‰ ์œ ํ˜•์œผ๋กœ ํ‘œ์‹œ๋ฉ๋‹ˆ๋‹ค.

ํŒ

GitHub Pages ์‚ฌ์ดํŠธ์—์„œ ๊ตฌ๋ฌธ์„ ๊ฐ•์กฐ ํ‘œ์‹œํ•˜๋ ค๋Š” ์šธํƒ€๋ฆฌ์นœ ์ฝ”๋“œ ๋ธ”๋ก์„ ๋งŒ๋“ค ๋•Œ ์†Œ๋ฌธ์ž ์–ธ์–ด ์‹๋ณ„์ž๋ฅผ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ GitHub Pages ๋ฐ Jekyll ์ •๋ณด์„(๋ฅผ) ์ฐธ์กฐํ•˜์„ธ์š”.

Linguist๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์–ธ์–ด ๊ฒ€์ƒ‰์„ ์ˆ˜ํ–‰ํ•˜๊ณ  ๊ตฌ๋ฌธ ๊ฐ•์กฐ๋ฅผ ์œ„ํ•ด ํƒ€์‚ฌ ๋ฌธ๋ฒ•์„ ์„ ํƒํ•ฉ๋‹ˆ๋‹ค. ์–ธ์–ด YAML ํŒŒ์ผ์—์„œ ์œ ํšจํ•œ ํ‚ค์›Œ๋“œ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๋‹ค์ด์–ด๊ทธ๋žจ ๋งŒ๋“ค๊ธฐ

์ฝ”๋“œ ๋ธ”๋ก์„ ์‚ฌ์šฉํ•˜์—ฌ Markdown์œผ๋กœ ๋‹ค์ด์–ด๊ทธ๋žจ์„ ๋งŒ๋“ค ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค. GitHub๋Š” Mermaid, GeoJSON, TopoJSON, ASCII STL ๊ตฌ๋ฌธ์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค. ์ž์„ธํ•œ ๋‚ด์šฉ์€ ๋‹ค์ด์–ด๊ทธ๋žจ ๋งŒ๋“ค๊ธฐ์„(๋ฅผ) ์ฐธ์กฐํ•˜์„ธ์š”.

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