(Mark Down) README.md 마크다운 작성법

코드를 설명하고 정리하는 방법 중 하나로 "마크다운"이라는 것을 알게 되었다.

 

이전에는 "주석"을 사용해서 코드에 설명을 추가하곤 했다.

 

하지만 더욱 깔끔한 코드 정리를 위해선 마크다운 작성이 필요하다.

 

특히 깃허브 README.md 파일을 통해 해당 리포지토리를 설명할 때, 마크다운을 깔끔하게 작성해야 가독성이 좋다.

 

그렇기에 마크다운의 정의에 대해서 알아보고 작성 문법에 대해서 기록하고자 한다.

 

마크다운

마크다운이란 일반 텍스트 기반의 경량 마크업 언어이다. 일반 텍스트로 서식이 있는 문서를 작성하는 데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단한 것이 특징이다.
HTML과 리치 텍스트(RTF) 등 서식 문서로 쉽게 변환되기 때문에 응용 소프트웨어와 함께 배포되는 README 파일이나 온라인 게시물 등에 많이 사용된다.

1. 텍스트 관련 문법 : 제목, 강조, 링크

1.1 제목 강조(Headers)

• Html의 h1~h6와 유사한 문서의 제목 등을 강조할 때는 # ~ ######처럼 맨 앞에 #의 개수로 조절한다.

1.2 문장의 중간을 강조하는 방법(bold와 italic)

• 문장의 중간에 강조하는 방법으로 두껍게(Bold) 하는 방법과 기울리기(italic) 방법이 있다.
  • 별표, 언더바 한 개로 강조할 문자를 감싸면 기울리기이다.
  • 별표, 언더바 두 개로 강조할 문자를 감싸면 두껍게된다.

1.3 취소선(Strike) 사용

• 문장 중간에 취소선을 넣는 방법이다.
  • 취소할 문자들을 물결 두개로 문자를 감싸면 취소선이 만들어진다.

1.4 하이퍼링크(Link)를 사용하는 방법

• 문서 중간에 'http://~'의 링크를 파악하면 자동으로 하이퍼링크가 걸리기도 한다.
• 하지만 텍스트로 변환하여 사용할 수 있는 방법이 있다.
  • [클릭할 텍스트](http://~.com)

2. 텍스트 관련 문법 : 인용구, 코드, 줄 바꿈

2.1 줄 바꿈

• 문서 내에서 줄 바꾸기 위해서는 엔터키 한 번으로 되지 않는다.
  • 줄 바꿈은 빈칸 두 번 이후 엔터키로 구분한다.

2.2 인용구 (Quote)

• 다른 문구나 외부를 참고할 때 사용한다.
• 인용구로 적은 부분은 왼쪽에 라인이 생기며 글자색이 회색으로 변경된다.
  • > (부등호)다음 인용된 문구를 적는다.

2.3 코드 블럭

• 프로그램 소스 코드를 그대로 사용할 수 있는 방법이다.
• 작은따옴표가 아닌 숫자 1 옆의 '~'키와 같이 있는 ` 키 세 번으로 다음과 같이 코드를 감싸준다.

• 프로그래밍 언어별 Syntax를 강조해 주는 기능도 있다.
• 첫 번째 라인 ` 기호 바로 뒤에 강조할 프로그래밍 언어를 적어준다.

3. 리스트와 테이블

3.1 리스트

• 순서가 있는 목록과 없는 목록으로 나뉜다.
• 숫자와 - 키를 이용해서 리스트를 구성할 수 있다.

3.2 체크 리스트

• 체크박스 형식의 리스트도 만들 수 있다.
• - [ ] : 빈 체크박스(괄호 안 공백필요), - [X] : 체크된 체크박스(괄호안 알파벳 x)

3.3 테이블

• 테이블(표) 작성 또한 가능하다.
• 방법은 다음의 그림을 참고한다.

• 테이블을 만들기 위해 일일이 작성하기는 번거롭다. 그렇기 때문에 마크다운으로 테이블 작성이 필요할 시, 다음의 링크를 참고하면 보다 편하게 테이블 작성을 할 수 있다.
  • 마크다운 테이블 생성기 : www.tablesgenerator.com/markdown_tables

Markdown Tables generator - TablesGenerator.com

4. 이미지 삽입하기

• 깃허브 README.md에 이미지를 추가하는 경우가 가장 잦다.
• 밑의 방법을 참고하여 이미지 추가를 쉽게 따라 할 수 있다.

 

• 첨부할 사진을 우클릭, '이미지 복사' 클릭 (ctrl+c)
• github 'issues'에서 'New issue' 클릭

 

• 'Leave a comment'에 우클릭 후 '붙여 넣기' (ctrl + v)
• ![Uploading image.png...]() 라는 문구가 잠시 떴다가 로 바뀔 것이다.
• 를 전체 드래그하여 복사 후, 마크다운에 붙여 넣기 하면 된다.

참조 : 위키백과_마크다운(https://ko.wikipedia.org/wiki/%EB%A7%88%ED%81%AC%EB%8B%A4%EC%9A%B4)

마크다운 - 위키백과, 우리 모두의 백과사전