Markdown 마크다운 (with Typora)

Markdown 이란?

• 텍스트 기반의 마크업 언어이다.
• 문서를 구조화하는 것이다.
• 텍스트를 HTML로 전환하는 툴이다.
• 쉽게 읽고 쓰기 위한 순수한 텍스트로 사용 가능하다.

특징

• 최소한의 문법으로 구조화한다.
• 다양한 환경에서의 변환이 가능하다.(Github, tistory 등)

 

활용 예시

README.md

• 오픈소스의 공식문서로 작성하거나 개인 프로젝트의 프로젝트 소개서로 활용한다. (Github 등에서)

기술 블로그

• 마크다운을 HTML, CSS, JS 파일 등으로 변환한다.
• Github pages 기능을 통해 호스팅한다.

기타

• Jupyter notebook, Notion과 같이 일반 SW에서도 많이 사용되고 있다.

 

마크다운 문법 (w/ Typora)

Heading

• 제목이나 소제목으로 사용한다.
• #의 개수에 따라 h1 ~ h6까지 표현 가능하다.
• 글자 크기를 조절하기 위해 사용해선 안된다. (글 작성 시 개요에 영향을 미치기 때문)

(#다음 띄어쓰기 필수)

List

• 순서가 있는 리스트(ol)와 순서가 없는 리스트(ul)가 있다. 
• #의 개수에 따라 h1 ~ h6까지 표현이 가능하다.
• 목록 활용시 단계를 tab으로 조절한다.

순서가 없는 리스트

• 사과
• 바나나
• 복숭아
  • 백도 복숭아
  • 천도 복숭아

( *(asterisk)와 띄어쓰기를 사용)

 

순서가 있는 리스트

<To Do List in the morning>

1. 세수하고 양치하기
2. 이불 정리하기
3. 노트북 키기
   1. 로그인
   2. 대시보드 확인

(숫자와 . 그리고 띄어쓰기를 사용한다)

 

Fenced Code block

• backtick 기호 3개를 이용한다. (```)
• 특정 언어를 언급하여 Syntax Highlighting 기능 사용이 가능하다. 

print('hellooo')

print('hellooo')
  # 주석
if True:
  print('t')

 

일일이 코드를 캡쳐하며 글을 정리하지 않아도 되는 편리성이 있다.

 

Inline Code block

• backtick 기호를 사용한다. (``)
• 특정 단어를 키워드로 쓸 때 사용한다.

EX) 결과값을 출력할 때에는 `print` 를 사용해야 한다.

 

Link

• 대괄호와 소괄호를 이용해 링크를 작성한다.
• 특정 파일을 포함하여 연결시킬 수 있다.

EX) MLP 홈페이지 바로가기

• 내부 파일(폴더) 링크하기
  • 소괄호에 ./를 붙인다
  • Markdown

 

이미지

 을 통해 이미지를 사용할 수 있다.

 

인용문 (Blockquotes)

• > 를 통해 인용문을 작성한다.

인용문

기타 문법

• 텍스트 강조 (공백 없이 사용한다)
  • 볼드체: 내용 (** 내용 **)
  • 이탤릭체: 내용 (* 내용 *)
  • 취소선: 내용 (~~ 내용 ~~)
• 수평선: - - - (띄어쓰기 없이 세 개 이상 사용한다)