마크다운(Markdown) 정리와 github ReadMe 작성

문득 내 초라한 깃헙 페이지와 repo 속 텅 빈 ReadMe가 눈에 들어왔다

그동안 "일단 공부하고 일단 코드치고 나중에 달아야지.." 하면서 미뤄두었는데...

마구잡이처럼 써둔 코드들처럼, 레포지토리들도 방치하니 가독성이 떨어진다.

그로 인해 더 볼품 없어 보이는 건 덤.. 

레포지토리 주인인 내가봐도 그런데, 다른 사람들이 보면 더 심하게 느껴지지 않을까.😪

 

이제라도 정리하고 싶어진 ReadMe들을 위해 마크다운 문법을 몇 개 정리해본다.

먼저 마크다운이란?

텍스트 기반의 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTML로 변환이 가능하다. 특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다.

 

 

(아래는 유튜브 드림코딩 엘리를 보고 정리한 내용)

1. heading - '#'(해쉬)를 이용 총 6개의 헤딩스타일. 많을수록 작아진다. 

 헤딩 1 아래에는 수평선이 O. 따로 추가하고 싶다면 underscore을 세개(___)

 

2. **로 wrap하게 되면 Bold체 /  *은 italic  / 물결 두개(~~)는 strikethrough(취소선)

  감싸지 않고 *을 앞에 달아주면 list bullet. 대쉬(-)를 사용해도 가능!

  list는 indent를 통해 depth가 결정 가능하다.

 

3. >을 사용해 quote안으로 넣을 수 있음. (blockquote)

 

4. link 사용 -> 대괄호 안에 원하는 문구, 소괄호 안에 주소

 

5. image 사용 -> ![img 링크] (깃헙 edit에서 pc이미지 드래그& 드롭도 가능)

  (but, 일관성있는 이미지를 위해선 html 태그 img를 이용해 크기-width를 지정해주는게 낫다.)

 

6. cell의 경우

|Header|Description|

|--||--|    -> 하이픈 사이 콜론으로 정렬이 가능
|Cell1|Cell2|

 

7. Code 삽입 - 백틱(`) 1 or 3개를 통해 inline 혹은 block으로 가능

 + 백틱 옆에 언어(ts, kotlin)을 명시해주면 하이라이트가 가능(!!!)

 

8. Task list - 목록 앞에 [] or [x] 을 통해 to-do list를 명시 가능

 

+ Github에선 github flavored markdown을 지원한당

 

-

마크다운 미리보기 사이트

https://stackedit.io/app#