Markdown

1. 마크다운 기반 문서 작성

2004년 존 그루버 가 만든 텍스트 기반의 가벼운 마크업(구조화된) 언어로 다양한 서식을 지원하고 다양한 환경에서 변환되어 보여질 수 있다.

ex)

• README.md

  • 오픈소스의 공식문서를 작성하거나, 개인 프로젝트의 프로젝트 소개서로 활용
  • 모든 페이지에 README.md를 넣어 문서를 바로 볼 수 있도록 활용

• 정적사이트 생성기(Static site generator)

  • Jekyll, Gatsby, Hugo, Hexo 등으로 작성된 마크다운을 HTML, CSS, JS 파일 등으로 변환하고, GitHub pages 기능을 통해 무료 호스팅이 가능

• 마크다운 기반 SW

  • Jupyter notebook에는 별도의 마크다운 셸로 프로젝트 내용과 분석 결과를 정리 가능함
  • Notion 과 같은 메모/노트 필기 SW 역시 마크다운 기반 문서 작성을 기본으로 함

2. 마크다운 문서 구성요소

<주의!> 글자 정렬 및 이미지 크기 조정은 기능상 불가능하며, 띄어쓰기를 주의해야 한다.

<중요!> 현재 위치(directory)를 기준으로 상대경로와 절대경로를 구분하는 것이 중요하다.

2-1. Heading

• 제목 또는 소제목으로 #의 개수에 따라서 위계가 표현되며, h1~h6까지 구성가능하다.

#       (h1)
##      (h2)
###     (h3)
####    (h4)
#####   (h5)
######  (h6)

2-2. List

• 순서가 있는 리스트(ol) (예시 모닝루틴 ) : 1. 2. 3.으로 표현한다.
• 순서가 없는 리스트(ul) (예시 점심메뉴) : 하이픈(-) 또는 Asterisk(*)를 사용하여 표현한다.

`Tab`을 사용하여 하위항목을 구성하고 `Shift + Tab`을 통해 상위항목으로 나올 수 있다.

ex) 순서있는 리스트

  1. 서론
    1. 연구의 배경 및 목적
      1. 연구의 배경
      2. 연구의 목적
    2.연구의 범위
  2. 본론
    1. 개발
      1. 개발의 정의
      2. 개발언어의 종류
    2. 개발 사례
    ...

ex) 순서없는 리스트

    - 한식
      -삼겹살
      -김치찌개
    - 일식
      - 초밥
      - 회
    - 중식
      - 짜장면
      - 짬뽕
      ...

2-3. Fened Code Block

• 코드블록으로 글상자를 통해 하이라이트되며 Backstick 3개 (``` 내용 ```)를 활용하여 표현한다.

ex) ``` 글상자 만들기 ```

2-4. Inline Code Block

: 글자의 색을 통해 하이라이트되며 Backstick 1개를 활용하여 표현한다.

ex) 개발은 `꾸준히` 하기

2-5. Link

: 특정 문서, 파일 및 사이트로 이동하는 기능으로 [문자열](url)로 작성이 가능하다.

ex
)

[TIL](https
://github.com/JeonggonCho/TIL)

2-6. Image

: 이미지로 링크와 유사하게 ! + [문자열(공백상관없음)](이미지 주소)로 표현한다.

ex)

![](../../assets/img/drawing1.jpg)

이미지 삽입 예시

2-7. Blockquotes

: 인용문 작성시 사용하며 방향표시(>)를 이용하여 표현한다.

ex)

> 너 자신을 알라 -소크라테스-

2-8. Table

: 표를 작성하는 기능으로 Typora 또는 Table Generator와 같은 써드파티 기능을 활용하는 것이 유리하다.

ex)

| number | language |
|--------|----------|
| 1      | Korean   |
| 2      | English  |
| 3      | French   |

2-9. 텍스트 강조

• 기울임은 Asterisk(*) 1개씩 단어 앞 뒤에 붙여서 표현하며 굵게는 Asterisk(*) 2개를 단어 앞 뒤에 붙여서 사용한다.

ex)

기울임, 굵게, 굵게기울임

*기울임*
**굵게**
***굵게기울임***

2-10. 수평선

• 선을 긋는 요소로 (---), (___), (***)로서 표현이 가능하다.

2-11. 취소선

• 취소 와 같이 특정글에 줄을 그어 취소를 표시하는 기능으로 (~~)를 특정글 앞 뒤에 붙여 표현한다.