Way to Use Markdown - kanujoa/OSS_Assignment GitHub Wiki

header

๋งˆํฌ๋‹ค์šด(Markdown) ์ด๋ž€:grey_question:

ํŒŒ์ผ ํ™•์žฅ์ž๊ฐ€ '.md' ์ธ ํŒŒ์ผ์„ ๋งํ•ฉ๋‹ˆ๋‹ค.

ํŠน์ˆ˜๊ธฐํ˜ธ์™€ ๋ฌธ์ž๋ฅผ ์‚ฌ์šฉํ•œ ๊ฐ„๋‹จํ•œ ๊ตฌ์กฐ์˜ ๋ฌธ๋ฒ•์„ ์‚ฌ์šฉํ•˜์—ฌ ์›น์—์„œ ๋ณด๋‹ค ๋น ๋ฅด๊ฒŒ ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•˜๊ณ  ๊ฐ€๋…์„ฑ๋„ ์ข‹๋‹ค๋Š” ๊ฒƒ์ด ํŠน์ง•์ž…๋‹ˆ๋‹ค.

HTML ๋กœ์˜ ๋ณ€ํ™˜๋„ ๊ฐ€๋Šฅํ•˜๋‹ค.

๋Œ€ํ‘œ์  ์˜ˆ์‹œ

github์—์„œ์˜ readme.md

--> ๋งˆํฌ๋‹ค์šด์„ ํ†ตํ•ด์„œ ํ”„๋กœ๊ทธ๋žจ ์„ค์น˜ ๋ฐฉ๋ฒ•, ์†Œ์Šค์ฝ”๋“œ ์„ค๋ช…, ์ด์Šˆ์— ๋Œ€ํ•œ ๋‚ด์šฉ ๋“ฑ์„ ๊ฐ„๋‹จํ•˜๊ฒŒ ๊ธฐ๋กํ•˜๊ธฐ ์œ„ํ•ด ์ž‘์„ฑํ•˜๋Š” ํŒŒ์ผ์ž…๋‹ˆ๋‹ค.

์žฅ์ 

โ–ถ๏ธ ๊ฐ„๊ฒฐํ•˜๊ณ  ๋ณ„๋„์˜ ๋„๊ตฌ ์—†์ด ์ž‘์„ฑ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

โ–ถ๏ธ ๋‹ค์–‘ํ•œ ํ˜•ํƒœ๋กœ์˜ ๋ณ€ํ™˜์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

โ–ถ๏ธ text๋กœ ์ €์žฅ๋˜๋ฏ€๋กœ ์šฉ๋Ÿ‰์ด ์ ์–ด ๋ณด๊ด€์ด ์šฉ์ดํ•˜๊ณ  VCS๋ฅผ ์ด์šฉํ•ด ๋ณ€๊ฒฝ ์ด๋ ฅ์„ ๊ด€๋ฆฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

โ–ถ๏ธ ์ง€์›ํ•˜๋Š” ํ”„๋กœ๊ทธ๋žจ๊ณผ ํ”Œ๋žซํผ์ด ๋‹ค์–‘ํ•ฉ๋‹ˆ๋‹ค.

๋‹จ์ 

โ–ถ๏ธ ํ‘œ์ค€์ด ์—†์œผ๋ฏ€๋กœ ๋„๊ตฌ์— ๋”ฐ๋ผ์„œ ๋ณ€ํ™˜ ๋ฐฉ์‹์ด๋‚˜ ์ƒ์„ฑ๋ฌผ์ด ๋‹ค๋ฅด๊ฒŒ ๋‚˜์˜ต๋‹ˆ๋‹ค.

โ–ถ๏ธ ๋ชจ๋“  HTML markup์„ ๋Œ€์‹ ํ•˜์ง€๋Š” ๋ชปํ•ฉ๋‹ˆ๋‹ค.



๐Ÿ“ƒ ๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ•

์ œ๋ชฉ(header)

โœ”๏ธ # ์„ ํ†ตํ•ด ์ œ๋ชฉ์„ ๋‚˜ํƒ€๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. #์˜ ๊ฐœ์ˆ˜๊ฐ€ ๋งŽ์•„์งˆ์ˆ˜๋ก ์ œ๋ชฉ์˜ ํฌ๊ธฐ๊ฐ€ ์ž‘์•„์ง‘๋‹ˆ๋‹ค.

# ์ œ๋ชฉ 1
## ์ œ๋ชฉ 2
### ์ œ๋ชฉ 3
#### ์ œ๋ชฉ 4
##### ์ œ๋ชฉ 5
###### ์ œ๋ชฉ 6

โœ”๏ธ ๋‹ค์Œ๊ณผ ๊ฐ™์ด HTML tag๋ฅผ ์ด์šฉํ•ด์„œ๋„ ๋‚˜ํƒ€๋‚ผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. h ์˜†์˜ ์ˆซ์ž๊ฐ€ ์ปค์งˆ์ˆ˜๋ก ์ œ๋ชฉ์˜ ํฌ๊ธฐ๊ฐ€ ์ž‘์•„์ง‘๋‹ˆ๋‹ค.

<h1> ์ œ๋ชฉ 1 </h1>
<h2> ์ œ๋ชฉ 2 </h2>
<h3> ์ œ๋ชฉ 3 </h3>
<h4> ์ œ๋ชฉ 4 </h4>
<h5> ์ œ๋ชฉ 5 </h5>
<h6> ์ œ๋ชฉ 6 </h6>

โ— ๊ฒฐ๊ณผ โ—

์ œ๋ชฉ 1

์ œ๋ชฉ 2

์ œ๋ชฉ 3

์ œ๋ชฉ 4

์ œ๋ชฉ 5
์ œ๋ชฉ 6



๊ฐ•์กฐ(emphasis)

โœ”๏ธ ์ดํ…”๋ฆญ์ฒด๋กœ ๋ณ€๊ฒฝ : ๋ณ„ํ‘œ(*) ๋˜๋Š” ์–ธ๋”๋ฐ”(_) ๋ฅผ ์ด์šฉํ•ฉ๋‹ˆ๋‹ค.

*์•ˆ๋…•ํ•˜์„ธ์š”* _๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค_

โ— ๊ฒฐ๊ณผ โ—

์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค


โœ”๏ธ ๋‘๊ป๊ฒŒ ๋ณ€๊ฒฝ : ๋ณ„ํ‘œ 2๊ฐœ(**) ๋˜๋Š” ์–ธ๋”๋ฐ” 2๊ฐœ(__) ๋ฅผ ์ด์šฉํ•ฉ๋‹ˆ๋‹ค.

**์•ˆ๋…•ํ•˜์„ธ์š”** __๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค__

โ— ๊ฒฐ๊ณผ โ—

์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค


โœ”๏ธ ์ดํ…”๋ฆญ์ฒด์™€ ๋‘๊ป๊ฒŒ๋ฅผ ๋™์‹œ์— ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ๋„ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

**_์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค._**

โ— ๊ฒฐ๊ณผ โ—

์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค.


โœ”๏ธ ์‚ญ์ œ์„  : ๋ฌผ๊ฒฐ ํ‘œ์‹œ 2๊ฐœ(~~) ๋ฅผ ์ด์šฉํ•ฉ๋‹ˆ๋‹ค.

~~์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค.~~

โ— ๊ฒฐ๊ณผ โ—

์•ˆ๋…•ํ•˜์„ธ์š” ๋ฐ˜๊ฐ‘์Šต๋‹ˆ๋‹ค.


๋ชฉ๋ก(list)

โœ”๏ธ ์ˆœ์„œ๊ฐ€ ํ•„์š”ํ•œ ๋ชฉ๋ก
: ์ˆซ์ž ์™€ ์  ์„ ์ ์–ด์ฃผ์–ด ํ‘œํ˜„ํ•ฉ๋‹ˆ๋‹ค. HTML tag์—์„œ๋Š” ol tag์— ํ•ด๋‹นํ•ฉ๋‹ˆ๋‹ค. ์–ด๋–ค ๋ฒˆํ˜ธ๋ฅผ ์ž‘์„ฑํ•ด๋„ ๋‚ด๋ฆผ์ฐจ์ˆœ์œผ๋กœ ์ •์˜๋ฉ๋‹ˆ๋‹ค.

1. first list
2. second list
3. third list
4. fourth list
5. fifth list

โ— ๊ฒฐ๊ณผ โ—

  1. first list
  2. second list
  3. third list
  4. fourth list
  5. fifth list


โœ”๏ธ ์ˆœ์„œ๊ฐ€ ํ•„์š”ํ•˜์ง€ ์•Š์€ ๋ชฉ๋ก
: ๊ธ€๋จธ๋ฆฌ ๊ธฐํ˜ธ์ธ *, +, โ€“ ๋ฅผ ์ด์šฉํ•˜์—ฌ ํ‘œํ˜„ํ•ฉ๋‹ˆ๋‹ค. HTML tag์—์„œ๋Š” ul tag์— ํ•ด๋‹น๋ฉ๋‹ˆ๋‹ค. ์ƒํ™ฉ์— ๋งž๊ฒŒ ํ˜ผ์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

* top list
    + middle list
        - last list

โ— ๊ฒฐ๊ณผ โ—

  • top list
    • middle list
      • last list


๋งํฌ(links)

โœ”๏ธ markdown์œผ๋กœ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

[๋Œ€์ฒด ํ…์ŠคํŠธ](๋Œ€์ฒด ํ…์ŠคํŠธ์— ํ•ด๋‹นํ•˜๋Š” ์ฃผ์†Œ "๋งํฌ ์„ค๋ช…")
[kanujoa's github](https://github.com/kanujoa "kanujoa์˜ github์ž…๋‹ˆ๋‹ค.")

โ— ๊ฒฐ๊ณผ โ—

kanujoa's github


โœ”๏ธ a tag๋ฅผ ์ด์šฉํ•ด์„œ๋„ ๋งํฌ๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

<a href = "๋Œ€์ฒด ํ…์ŠคํŠธ์— ํ•ด๋‹นํ•˜๋Š” ์‚ฌ์ดํŠธ ์ฃผ์†Œ"> ๋Œ€์ฒด ํ…์ŠคํŠธ



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

โœ”๏ธ markdown์œผ๋กœ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋งํฌ ์ž‘์„ฑ๋ฒ•๊ณผ ๋น„์Šทํ•˜์ง€๋งŒ ์•ž์— ! ์„ ๋ถ™์–ด์ฃผ์–ด์•ผ ํ•œ๋‹ค๋Š” ๊ฒƒ์ด ํŠน์ง•์ด๋‹ค.

![๋Œ€์ฒด ํ…์ŠคํŠธ](๋Œ€์ฒด ํ…์ŠคํŠธ์— ํ•ด๋‹นํ•˜๋Š” ์ฃผ์†Œ "๋งํฌ ์„ค๋ช…")
![ํ•‘๊ตฌ](https://user-images.githubusercontent.com/99963066/196168409-6bc76484-6832-4b9c-9268-c384dffab92b.png "ํ•‘๊ตฌ ์‚ฌ์ง„")

โ— ๊ฒฐ๊ณผ โ—

ํ•‘๊ตฌ


โœ”๏ธ img tag๋ฅผ ์ด์šฉํ•ด์„œ๋„ ์ด๋ฏธ์ง€ ์‚ฝ์ž…์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

<img src = "์ด๋ฏธ์ง€ ์ฃผ์†Œ"/>



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

โœ”๏ธ ``` ์˜†์— ์ž‘์„ฑํ•˜๊ธธ ์›ํ•˜๋Š” ์–ธ์–ด๋ฅผ ๊ธฐ์ž…ํ•˜๊ณ  ์•„๋ž˜์— ์ฝ”๋“œ ์ž…๋ ฅ ํ›„ ๋‹ค์‹œ ```๋กœ ๋‹ซ์•„์ฃผ๋ฉด ๋ฉ๋‹ˆ๋‹ค.

def function():
    print("hello")     # python ์ฝ”๋“œ ๋ธ”๋ก




์ธ์šฉ

โœ”๏ธ ์ธ์šฉ๋œ ๋ถ€๋ถ„์— '>' ์„ ๋ถ™์—ฌ ํ‘œํ˜„ํ•ฉ๋‹ˆ๋‹ค. blockquote tag๋กœ ๋ณ€ํ™˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

> ์ธ์šฉ 1
> ์ธ์šฉ 2
> ์ธ์šฉ 3

โ— ๊ฒฐ๊ณผ โ—

์ธ์šฉ 1
์ธ์šฉ 2
์ธ์šฉ 3

โœ”๏ธ '>>' ์„ ์‚ฌ์šฉํ•˜์—ฌ ์ค‘์ฒฉ์„ ํ‘œํ˜„ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

> ์ธ์šฉ 1
>> ์ธ์šฉ 2
>      # ์ธ์šฉ ์ˆ˜์ค€์ด ๋ณ€๊ฒฝ๋  ๋•Œ ์˜†๊ณผ ๊ฐ™์ด ๋นˆ ์ค„์„ ํ•˜๋‚˜ ๋งŒ๋“ค์–ด ์ค€๋‹ค.
> ์ธ์šฉ 3

โ— ๊ฒฐ๊ณผ โ—

์ธ์šฉ 1

์ธ์šฉ 2

์ธ์šฉ 3


ํ‘œ(table)

โœ”๏ธ ํ—ค๋” ์…€์„ ๊ตฌ๋ถ„ํ•  ๋•Œ 3๊ฐœ ์ด์ƒ์˜ โ€“ ๊ธฐํ˜ธ๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

โœ”๏ธ ํ—ค๋” ์…€์„ ๊ตฌ๋ถ„ํ•˜๋ฉด์„œ : ๊ธฐํ˜ธ๋กœ ์…€(์—ด/์นธ) ์•ˆ์— ๋‚ด์šฉ์„ ์ •๋ ฌํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

โœ”๏ธ ๊ฐ€์žฅ ์ขŒ์ธก๊ณผ ๊ฐ€์žฅ ์šฐ์ธก์— ์žˆ๋Š” | ๊ธฐํ˜ธ๋Š” ์ƒ๋žต์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

โœ”๏ธ table tag๋กœ ๋ณ€ํ™˜์ด ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

| ์ด๋ฆ„ | ๊ณผ๋ชฉ | ์„ฑ์  |
|---|:---:|---:|
| A | ๊ตญ์–ด | 80 |
| B | ์ˆ˜ํ•™ | 90 |
| C | ์˜์–ด | 40 |
| D | ๊ณผํ•™ | 60 |

โ— ๊ฒฐ๊ณผ โ—

์ด๋ฆ„ ๊ณผ๋ชฉ ์„ฑ์ 
A ๊ตญ์–ด 80
B ์ˆ˜ํ•™ 90
C ์˜์–ด 40
D ๊ณผํ•™ 60




์ฃผ์„

โœ”๏ธ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ฃผ์„์„ ์ž‘์„ฑํ•˜๋ฉด ์™„์„ฑ๋œ md ๋ฌธ์„œ์—์„œ๋Š” ๊ทธ ๋‚ด์šฉ์ด ๋…ธ์ถœ๋˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

<!-- ์ฃผ์„์ž…๋‹ˆ๋‹ค. -->
โš ๏ธ **GitHub.com Fallback** โš ๏ธ