프로젝트

드림코딩 : 마크다운(Markdown) + 깃허브 리드미 파일 작성 Tip

식초 2021. 4. 1. 21:34

마크다운(Markdown) 이란?

  • 많은 개발자들이 일상 생활에서 쓰고 있는 언어. 갓성비 언어. 5분 안에 배울 수 있음
  • .md 확장자 파일
  • 깃허브 리드미 파일 / PR (Pull Request) 설명 / 디지털 노트 /텍스트 에디터 에서 키보드 만으로  사용 가능하다!
  • 마크다운 언어 잘 사용하면 -> 멋진 문서를 만들 수 있음!

 

마크다운 간단 문법 정리

-vs code 사용시, <Preview markdown>이용해서 실시간 확인 가능.

 

제목 & 문장 : # 붙이기, #개수 많을 수록 작아짐, 그냥 쓰면 문장

 

줄긋기 : 언더라인 3개

 

글씨체 : ** | * | ~~ 을 앞뒤로 붙여준다

 

인용문 : >을 앞에 붙인다

 

목록 : * | - 을 앞에 붙인다

 

숫자 목록 : 1. 을 붙인다

 

클릭 링크 : [ 문구 ] ( 링크 ) 

 

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

 

테이블 : |제목, 내용|  |--| 선긋기 |:--| 왼쪽 정렬 |--:| 오른쪽 정렬 |:--:| 가운데 정렬

 

코드 : ` ` 로 감싸주면 인라인으로 코드화 된다 

        ``` 로 위아래를 감싸주면 코드블럭이 생긴다

        ```js 로 코드의 언어를 표현해주면 문법이 하이라이트 된다

 

 

 

 

 

 

깃허브 리드미 파일 작성 Tip

 

깃허브 flavor 마크다운

깃허브에서 사용하는 마크다운 (기존과 비슷)

+ 체크 목록(Task List) 추가 가능 = to-do 리스트 추가 가능

+ 사진은 드래그-드롭으로 리드미 Edit 중 추가 가능 -> 자동 링크화

   사진 크기 조절 : <img src="..." width ="..."> 처럼 HTML img의 width 속성 사용한다

 

guides.github.com/features/mastering-markdown/

 

Mastering Markdown · GitHub Guides

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. What you will learn: How the Markdown format makes styled collaborative editing easy How Markdown differs from traditional formatting approaches How t

guides.github.com

영상 예저 코드 링크

github.com/dream-ellie/markdown

 

dream-ellie/markdown

Learn Markdown with Me :). Contribute to dream-ellie/markdown development by creating an account on GitHub.

github.com