본문 바로가기
복수전공(소프트웨어공학)/Python, Linux, Git 등

[유튜브] 마크다운 6분 순삭 정리 - 깃허브 리드미 파일 작성 팁

by 차엔진 2021. 2. 8.

# Markdown

경량형 마크업 언어로, txt 에디터에서도 쉽게 포맷하면서 빠르게 문서를 작성할 수 있음, .md 확장자파일임.

깃허브 README.md, PR(=Rull Request) 설명에서도 많이 사용됨.

 

# 기초문법

 

글 : 일반 텍스트

#글 : 헤딩

>글: 인용구

___ or --- or *** : 구분선

 

# Heading 1

Heading 1                    

#### Heading 6 Heading 6
>>> quote3

❙ ❙ ❙ quote3

 

**글** : 볼드체

*글* : 이탈릭

~~글~~ : 취소선

 

+ or - or *글 : 목록

1. 글 : 숫자 목록

- [ ] 글 : 체크리스트(ㅁ)

- [x] 글 : 체크리스트()

 

[원하는 단어/문장](링크) : 하이퍼링크

![이미지 설명](이미지의 링크) : 이미지 추가

<img src="이미지의 링크" width="숫자%"> : 이미지 크기 조절

 

|Header|Description| : 엑셀

|--|--| : 테이블로 변환

|글1|글2|

|글3|글4|

|:--|:--| : 왼쪽 정렬

|:--:|:--:| : 중간 정렬

|--:|--:| : 오른쪽 정렬

 

Header Description
글1 글2
글3 글4

 

`코드` : 인라인 형태로 포맷

```java : 맨 위에 코드 랭귀지를 써주면 문법 하이라이트

코드

``` : 코드블럭 생성

 

 

blog.naver.com/imcjpak1k/221817574785

 

vscode: Markdown Preview Enhanced

vscode에서 markdown의 내용을 미리보기하는 확장프로그램으로 사용방법은 설치하고 단축키만 알면 쉽게 사...

blog.naver.com

caileb.tistory.com/201

 

GitHub - Image 올리기 (README, Issue, PR)

GitHub - Image 올리기 GitHub를 사용해서 코드를 관리하다 보면, 가끔 사진(Image) 파일을 올려야할 때가 종종 있다. 예를 들면, 프로젝트의 설명을 작성하는 README.md 파일에 이해를 돕기 위해 프로그램

caileb.tistory.com

github.com/tiimgreen/github-cheat-sheet/blob/master/README.ko.md

 

tiimgreen/github-cheat-sheet

A list of cool features of Git and GitHub. Contribute to tiimgreen/github-cheat-sheet development by creating an account on GitHub.

github.com

gist.github.com/ihoneymon/652be052a0727ad59601

 

마크다운(Markdown) 사용법

마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com