๐Ÿ’ก๋งˆํฌ๋‹ค์šด ์‚ฌ์šฉ๋ฒ• ์ •๋ฆฌ

sujinยท2021๋…„ 10์›” 30์ผ
0

TIL

๋ชฉ๋ก ๋ณด๊ธฐ
1/14
post-thumbnail

๐Ÿคทโ€โ™€๏ธ๋งˆํฌ๋‹ค์šด์ด๋ž€??

๋งˆํฌ๋‹ค์šด(markdown)์€ ์ผ๋ฐ˜ ํ…์ŠคํŠธ ๊ธฐ๋ฐ˜์˜ ๊ฒฝ๋Ÿ‰ ๋งˆํฌ์—… ์–ธ์–ด๋‹ค. 

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


โœ…๋งˆํฌ๋‹ค์šด ๋ฌธ๋ฒ•

1. ์ œ๋ชฉ

  • '#'๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•
# ์ œ๋ชฉ์€
### 1๊ฐœ๋ถ€ํ„ฐ
###### 6๊ฐœ๊นŒ์ง€ ๊ฐ€๋Šฅํ•˜๋‹ค.
  • '---' ๋˜๋Š” '===' ์‚ฌ์šฉ
์ œ๋ชฉ
====
๋ถ€์ œ๋ชฉ
---

2. ๋ชฉ๋ก

  • ์ˆœ์„œ๊ฐ€ ์žˆ๋Š” ๋ชฉ๋ก
1. ์ฒซ๋ฒˆ์งธ
2. ๋‘๋ฒˆ์งธ
3. ์„ธ๋ฒˆ์งธ
  • ์ˆœ์„œ๊ฐ€ ์—†๋Š” ๋ชฉ๋ก (*, +, -)
* 1๋ฒˆ๊ธ€
    + 1-1๋ฒˆ๊ธ€
    + 1-2๋ฒˆ๊ธ€
* 2๋ฒˆ๊ธ€
  • 1๋ฒˆ๊ธ€
    • 1-1๋ฒˆ๊ธ€
    • 1-2๋ฒˆ๊ธ€
  • 2๋ฒˆ๊ธ€

3. ์ธ์šฉ๋ฌธ๊ตฌ

> blockQuote
> >blockQuote

blockQuote

blockQuote


4. ์ฝ”๋“œ์‚ฝ์ž…

  • "```" ์‚ฌ์šฉ

    github ์—์„œ๋Š” ์ฝ”๋“œ ์‹œ์ž‘์ ์— ์‚ฌ์šฉํ•˜๋Š” ์–ธ์–ด๋ฅผ ์„ ์–ธํ•˜์—ฌ ๋ฌธ๋ฒ•๊ฐ•์กฐ๊ฐ€ ๊ฐ€๋Šฅํ•˜๋‹ค. (ํ•„์ˆ˜๋Š” ์•„๋‹˜)
์ฝ”๋“œ๋“ค..
  • "preํƒœ๊ทธ์‚ฌ์šฉ"
<pre>
<code>
์ฝ”๋“œ๋“ค..
</code>
</pre>

5. ์ˆ˜ํ‰์„ 

***
-----
<hr/>




6. ๊ฐ•์กฐ(*, _ ์‚ฌ์šฉ)

*์ดํƒœ๋ฆญ์ฒด*
**๋ณผ๋“œ์ฒด**
***์ดํƒœ๋ฆญ+๋ณผ๋“œ์ฒด***
~~์ทจ์†Œ์„ ~~

์ดํƒœ๋ฆญ์ฒด
๋ณผ๋“œ์ฒด
์ดํƒœ๋ฆญ+๋ณผ๋“œ์ฒด
์ทจ์†Œ์„ 


7. ๋„์–ด์“ฐ๊ธฐ

๋„์–ด์“ฐ๊ธฐ๋ฅผ ์—ฌ๋Ÿฌ๋ฒˆ ย ย ย ์ ์šฉ์„ํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด

&nbsp;&nbsp;&nbsp;

8. ์ค„๋ฐ”๊ฟˆ

๋ฌธ์žฅ ๋งˆ์ง€๋ง‰์—์„œ ์„ธ์นธ๋›ฐ์–ด์“ฐ๊ธฐ๋ฅผ ํ•˜๋ฉด๋œ๋‹ค.   
ํ˜น์€ <br> 
ํ˜น์€ <p> </p>๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด๋œ๋‹ค.

๋ฌธ์žฅ ๋งˆ์ง€๋ง‰์—์„œ ์„ธ์นธ๋›ฐ์–ด์“ฐ๊ธฐ๋ฅผ ํ•˜๋ฉด๋œ๋‹ค.
ํ˜น์€

ํ˜น์€

๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด๋œ๋‹ค.


9. ๋งํฌ

  • ์ฐธ์กฐ ๋งํฌ
Link1 : [Google][googlelink]

[googlelink]: https://google.com "Go google"

Link1 : Google

  • ์ธ๋ผ์ธ ๋งํฌ(=์™ธ๋ถ€๋งํฌ)
Link1 : [Google](https://google.com, "google link")

Link2 : <a href="https://www.naver.com" target="_blank" title="๋„ค์ด๋ฒ„">naver</a>

Link1 : Google
Link2 : naver

  • URL ๋งํฌ, ์ด๋ฉ”์ผ๋งํฌ
URL ๋งํฌ: <http://example.com/>
์ด๋ฉ”์ผ๋งํฌ: <address@example.com>

URL ๋งํฌ: http://example.com/
์ด๋ฉ”์ผ๋งํฌ: address@example.com

  • ๋‹ค๋ฅธ mdํŒŒ์ผ๋กœ ์ด๋™

์ƒ๋Œ€ ๊ฒฝ๋กœ๋ฅผ ์ด์šฉํ•ด์•ผํ•œ๋‹ค.

์˜ˆ1) ํ˜„์žฌ ์œ„์น˜์ธ ETCํŒŒ์ผ์˜ markdown.mdํŒŒ์ผ์—์„œ ์ƒ์œ„์˜ README.md๋กœ ์ด๋™ํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด?

[README.md๋กœ ์ด๋™](../README.md)

README.md๋กœ ์ด๋™

์˜ˆ2) ํ˜„์žฌ ์œ„์น˜์ธ ETCํŒŒ์ผ์˜ markdown.mdํŒŒ์ผ์—์„œ spring์˜ controller/ HttpServletRequest, HttpServletResponse.md๋กœ ์ด๋™ํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด?

[controller๋กœ ์ด๋™](../Spring/Controller/HttpServletRequest, HttpServletResponse.md)

controller๋กœ ์ด๋™

  • ๊ฐ™์€ mdํŒŒ์ผ ์•ˆ์—์„œ์˜ ์ด๋™
[๊ฐ™์€ mdํŒŒ์ผ ์•ˆ์—์„œ ์ด๋™](#9.-๋งํฌ)
์ฃผ์˜ํ•  ์  : ๊ณต๋ฐฑ์€ -์œผ๋กœ๋ฐ”๊พผ๋‹ค.
์ด๋ชจ์ง€, ๋งˆ์นจํ‘œ(.), ์ฝค๋งˆ(,)์ƒ๋žต 

๊ฐ™์€ mdํŒŒ์ผ ์•ˆ์—์„œ ์ด๋™


10. ์ด์Šค์ผ€์ดํ”„๋ฌธ์ž

\### ์ถœ๋ ฅ
### ์ถœ๋ ฅ

### ์ถœ๋ ฅ

์ถœ๋ ฅ


11. ์ด๋ชจํ‹ฐ์ฝ˜

  • ์ฒดํฌ๋ฐ•์Šค
    • [] ๋นˆ ์ฒดํฌ๋ฐ•์Šค
    • ์ฒดํฌ๋ฐ•์Šค
    * [] ๋นˆ ์ฒดํฌ๋ฐ•์Šค
    * [X] ์ฒดํฌ๋ฐ•์Šค
  • ์ด๋ชจ์ง€
    ๋งŽ์ด ์‚ฌ์šฉํ•˜๋Š” ๊ฑด : ๐Ÿ’กโœ”๏ธโŒโ“โ”๐Ÿ‘€โž•โž–โš ๏ธ๐Ÿ“๐Ÿง๐Ÿ‘๐Ÿ‘Ž
    https://gist.github.com/rxaviers/7360908

13. ์š”์•ฝ

์š”์•ฝํ•˜๊ธฐ

ํด๋ฆญ์‹œ์—๋Š” ์š”์•ฝ์˜
์„ค๋ช…์ด ๋œน๋‹ˆ๋‹ค!


<details>
<summary>์š”์•ฝํ•˜๊ธฐ</summary>

ํด๋ฆญ์‹œ์—๋Š” ์š”์•ฝ์˜     
์„ค๋ช…์ด ๋œน๋‹ˆ๋‹ค!
</details>

12. ์ด๋ฏธ์ง€

!๋ฅผ ์ด์šฉํ•˜๋ฉด๋œ๋‹ค.
![์—‘๋ฐ•์‹œ ๋ณด์—ฌ์งˆ ์ด๋ฏธ์ง€๋ช…](์ด๋ฏธ์ง€์ฃผ์†Œ)](๋งํฌ์ฃผ์†Œ)

![puppy-1903313_640](https://user-images.githubusercontent.com/31085727/39238230-b2ebb084-48b8-11e8-9e06-0a1743b253e7.jpg "๊ฐ•์•„์ง€")

<img src="https://user-images.githubusercontent.com/31085727/39238230-b2ebb084-48b8-11e8-9e06-0a1743b253e7.jpg" width="100px" height="100px" title="px(ํ”ฝ์…€) ํฌ๊ธฐ ์„ค์ •" alt="๊ฐ•์•„์ง€"/>


์ด๋ฏธ์ง€์˜ src๋ฅผ ์–ป์–ด ๋‚ด๊ธฐ ์œ„ํ•ด ์•ฝ๊ฐ„์˜ ํŠธ๋ฆญ์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
๋ฐ”๋กœ github ํ”„๋กœ์ ํŠธ์˜ Issue๋ฅผ ์ด์šฉํ•˜๋Š” ๊ฒƒ์ด๋‹ค. ์ด ๋ฐฉ๋ฒ•์œผ๋กœ ์ด๋ฏธ์ง€ ๋ฟ๋งŒ์•„๋‹ˆ๋ผ ๋™์˜์ƒ๋„ ์ถ”๊ฐ€ํ•  ์ˆ˜ ์žˆ๋‹ค.

1. github ํ”„๋กœ์ ํŠธ์˜  Issueํƒญ์œผ๋กœ ๋“ค์–ด๊ฐ„๋‹ค.
2. New Issue๋ฒ„ํŠผ
3. ์–ป๊ณ ์žํ•˜๋Š” ์ด๋ฏธ์ง€๋ฅผ ๋“œ๋ž˜๊ทธ ์•ค ๋“œ๋ž
4. "<img src=~~>" ํ˜•์‹์˜ ๋ฌธ์ž์—ด๋กœ ๋ฐ˜ํ™˜๋œ๋‹ค. ์ด๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด๋œ๋‹ค.

13. ํ…Œ์ด๋ธ”

<!-- Markdown -->
Title1|Title2
-|-
content1|content2
content3|content4
  
Title1|Title2|Title3
:-|:-:|-:
content1|content2|content3
<!-- Html -->
<figure>
    <table>
        <thead>
            <tr>
                <th>Title1</th>
                <th>Title2</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>content1</td>
                <td>content2</td>
            </tr>
            <tr>
                <td>content3</td>
                <td>content4</td>
            </tr>
        </tbody>
    </table>
</figure>
  
<figure>
    <table>
        <thead>
            <tr>
                <th style='text-align:left;' >Title1</th>
                <th style='text-align:center;' >Title2</th>
                <th style='text-align:right;' >Title3</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td style='text-align:left;' >content1</td>
                <td style='text-align:center;' >content2</td>
                <td style='text-align:right;' >content3</td>
            </tr>
        </tbody>
    </table>
</figure>
Title1Title2
content1content2
content3content4
Title1Title2Title3
content1content2content3
Title1 Title2
content1 content2
content3 content4
Title1 Title2 Title3
content1 content2 content3

์ถœ์ฒ˜ https://github.com/mangdo/TIL

profile
๊ฐœ๋ฐœ๋Œ•๋ฐœ

0๊ฐœ์˜ ๋Œ“๊ธ€