[GitHub] 마크다운 작성하기(Markdown)

2022. 3. 8. 14:00·Git & GitHub/기타(마크다운 등)

마크다운 작성하는 법

출처

  • https://gist.github.com/ihoneymon/652be052a0727ad59601
  • https://velog.io/@yuuuye/velog-%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4MarkDown-%EC%9E%91%EC%84%B1%EB%B2%95
  • https://thisblogbusy.tistory.com/entry/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4Markdown-%EC%9D%B4%EB%9E%80

1. 마크다운의 정의


1-1. 마크다운이란?


마크다운이란 2004년 존그루버가 만든 텍스트 기반의 마크업 언어이다. 쉽게 읽고 쓸 수 있으며 HTML로 변환도 가능해 간편하다. 단 모든 HTML을 지원하지는 않는다. 작성법은 특수기호와 문자를 이용하며, 문법이 간단한 편이라 웹에서도 빠르게 컨텐츠를 작성할 수 있고 읽기도 좋다. 마크다운이 많이 쓰이기 시작한 때는 GitHub가 생겨난 후 부터이다. 깃허브의 원격저장소에 관한 정보를 기록하고 알려주는 README는 마크다운 언어로 쓰인다. 이를 기점으로 온라인 게시물에도 마크다운 언어를 많이 사용하기 시작했다.


2. 마크다운 작성법


2-1. 타이틀 작성


HTML과 비슷하게 h1 ~ h6 지원

h1
======
h2
------

# h1
## h2
### h3
#### h4
##### h5
###### h6

h1

h2


h1

h2

h3

h4

h5
h6



2-2. 인용블럭(BlockQuote)


HTML의 blockquote 태그와 같다. 인용구문은  > 기호를 사용하는데, 아래와 같이 중첩이 가능하다.
> 인용구문1
>   > 인용구문2
>   >   > 인용구문3

인용구문1

인용구문2

인용구문3



2-3. 목록


2-3-1. 순서가 있는 목록

 숫자 와  . 을 이용해 목록을 작성한다.

1. 1번
2. 2번
3. 3번
  1. 1번
  2. 2번
  3. 3번

2-3-2. 순서가 없는 목록

 * ,  + ,  - 를 지원한다.

- 목록1
  - 목록 2
    - 목록 3

* 목록 3

+ 목록 4
  • 목록1

    • 목록 2
      • 목록 3
  • 목록 3

  • 목록 4



2-4. 폰트 스타일


글자를 굵게 만들거나 기울여쓰기, 취소라인 그리기, 글자 꾸미기 등이 가능하다.
  • 기본적인 강조 표현
__bold__
**bold**
_italic_
*italic*
~~cancleLine~~

bold

bold

italic

italic

cancleLine


  • 글자에 색 넣기
<span style="color:blue">글자파란색</span>
<span style="background-color: #f6f8fa">회색형광펜</span>

글자파란색

회색형광펜



2-5. 문단 스타일


수평선이나 줄바꿈, 띄어쓰기 등을 통해 문단을 구분하는 기준을 표기할 수 있다.
<hr/>  # 수평선
<br/>  # 줄바꿈
&nbsp; # 띄어쓰기(여러번 가능)



2-6. 코드


2-6-1. 코드 그대로 보여주기


백틱(`)을 사용하면 코드를 그대로 보여줄 수 있다.
`<hr/>`

<hr/>


2-6-2. 코드블럭


코드 블럭을 사용할 수 있는 2가지 방식이 있다.
  • <pre><code></code></pre> 사용하기
<pre>
<code>
코드작성!!!
</code>
</pre>

코드작성!!!


  • 백틱(`) 사용하기

```
코드작성!!!
```

위와 같이 백틱(`)을 3번 겹쳐 사용하면 코드블럭을 만들어 사용할 수 있다.

코드작성!!!

  • 코드 문법 강조하기

아래와 같이 백틱 첫번째 줄에 언어명을 적어주면 코드 문법강조가 가능하다.


```python
a = 10
b = 20
print(a+b)
```
a = 10
b = 20
print(a+b)



2-7. 링크


링크의 종류로는 참조링크, 외부링크, 자동연결 등이 있다.
  • 참조링크
**참조링크**
[link keyword][id]

[id]: URL 주소 "Optional Title"

**예시**
블로그 링크: [myvelop][blogLink]

blogLink: https://myvelop.tistory.com/ "Go Blog"

블로그 링크: myvelop

여기서 "Optional Title"은 링크에 마우스를 올렸을 때 나오는 설명을 덧붙일 수 있는 기능이다.


  • 외부링크
**외부링크**
[Title](link)

**예시**
블로그링크: [myvelop](https://myvelop.tistory.com/)

블로그링크: myvelop


  • 자동연결

URL 주소를 그대로 가져와 링크를 만든다. (<> 생략가능)

블로그링크: <https://myvelop.tistory.com/>

블로그링크: https://myvelop.tistory.com/



2-8. 이미지


  • 링크 걸기

링크나 경로를 통해 이미지를 가져와야한다. 이미지의 URL링크나 파일에 저장되어 있는 이미지를 가져와 이미지를 표시할 수 있다.

**이미지 링크**
![이미지설명](path/img.jpg)
![이미지설명](path/img.jpg "Optional title")

**예시**
![그림](https://cdn.pixabay.com/photo/2022/02/26/08/23/people-7035403_960_720.jpg)

그림


  • 이미지 크기 조절하기

마크다운에서 따로 지원하는 크기 조절 문법이 없기 때문에 HTML의 문법인 <img src="" width="" height=""></img> 를 이용해야한다.

**크기조절**
<img src="path/img.jpg" width="" height="" title="" alt=""></img>

**예시**
<img src="https://cdn.pixabay.com/photo/2022/02/26/08/23/people-7035403_960_720.jpg" width="300px" height="20%" title="그림" alt="그림"></img>

그림



2-9. 이모지


이모지 링크 : https://kr.piliapp.com/twitter-symbols/
위의 이모지를 복사 붙여넣기 하면 마크다운에서도 이모지를 사용할 수 있다.

😀😃🧐👄



2-10. 테이블 만들기


참고 자료:
https://inasie.github.io/it%EC%9D%BC%EB%B0%98/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4-%ED%91%9C-%EB%A7%8C%EB%93%A4%EA%B8%B0/

| 으로 열을 구분하며, 폰트스타일이 적용 가능하다.
하이픈(-)과 콜론(:)을 이용하면 정렬도 가능하다. 콜론이 왼쪽에만 있으면 왼쪽 정렬, 양쪽에 있으면 가운데 정렬, 오른쪽에만 있으면 오른쪽 정렬이다.

| 제목 | 작가 | 출판일 |
|:-----|:----:|----:|
| 제목1 | 작가1 | 출판일1 |
| 제목2 | 작가2 | 출판일2 |

제목 작가 출판일
제목1 작가1 출판일1
제목2 작가2 출판일2



마무리

vscode에서 마크다운 preview 사용 단축키 : Ctrl + Shift + v

10분 마크다운 배우기: 마크다운 배우기


티스토리에서 마크다운 사용하기: 티스토리 마크다운

'Git & GitHub/기타(마크다운 등)' 카테고리의 다른 글
  • [Github] 마일스톤 세우는 법
  • [GitHub] 깃허브 프로필 꾸미는 법
gakko
gakko
좌충우돌 개발기
  • gakko
    MYVELOP 마이벨롭
    gakko
  • 전체
    오늘
    어제
    • 분류 전체보기 (203)
      • Spring (23)
        • Spring (10)
        • Spring Boot (7)
        • Spring Security (1)
        • Hibernate (4)
      • Test (3)
      • 끄적끄적 (6)
      • 활동 (35)
        • 부스트캠프 (23)
        • 동아리 (3)
        • 컨퍼런스 (3)
        • 글또 (5)
        • 오픈소스 컨트리뷰션 (1)
      • 디자인패턴 (0)
      • Git & GitHub (22)
        • Git (13)
        • Github Actions (1)
        • 오류해결 (5)
        • 기타(마크다운 등) (3)
      • 리눅스 (6)
        • 기초 (6)
        • 리눅스 서버 구축하기 (0)
      • Infra (2)
        • Docker (1)
        • Elastic Search (0)
        • Jenkins (1)
        • AWS (1)
      • MySQL (7)
        • 기초 (6)
        • Real MySQL (1)
      • 후기 (3)
        • Udemy 리뷰 (3)
      • CS (26)
        • 웹 기본지식 (0)
        • 자료구조 (13)
        • 운영체제 OS (12)
        • 데이터베이스 (1)
        • 시스템 프로그래밍 (0)
        • 기타 (0)
      • Tools (1)
        • 이클립스 (1)
        • IntelliJ (0)
      • 프로젝트 (1)
        • 모여모여(부스트캠프) (1)
      • JAVA (32)
        • Maven (6)
        • 오류해결 (11)
        • 자바 클래스&메소드 (1)
        • JSP & Servlet (12)
      • Javascript (5)
        • 기초 (3)
        • React (2)
      • Python (28)
        • 파이썬 함수 (9)
        • 알고리즘 문제풀이 (16)
        • 데이터 사이언스 (2)
        • 웹 크롤링 (1)
      • 단순정보전달글 저장소 (0)
  • 블로그 메뉴

    • 홈
    • 태그
    • 방명록
  • 링크

    • 우진님
  • 공지사항

  • 인기 글

  • 태그

    java
    스프링
    Python
    Git
    MySQL
    오류해결
    부스트캠프 7기
    스프링부트
    GitHub
    Spring
    부스트캠프
    운영체제
    웹개발
    파이썬
    자바
    알고리즘
    jsp
    자바스크립트
    os
    부스트캠프 멤버십
  • 최근 댓글

  • hELLO· Designed By정상우.v4.10.0
gakko
[GitHub] 마크다운 작성하기(Markdown)
상단으로

티스토리툴바