마크다운 시작하기

마크다운(markdown)은 일반 텍스트 문서의 양식을 편집하는 문법이다. README 파일이나 온라인 문서, 혹은 일반 텍스트 편집기로 문서 양식을 편집할 때 쓰인다. 마크다운을 이용해 작성된 문서는 쉽게 HTML 등 다른 문서형태로 변환이 가능하다.

GitLab은 마크다운을 권장하며 commit 메시지, 위키, 마일스톤, 이슈 등의 내용을 입력 시 마크다운 문법을 사용하도록 되어 있다.

1. 마크다운 치트시트

markdown

2. 마크다운 기본 문법

문단과 문단 사이는 빈 줄로 구분한다.

하나의 문단.

다른 문단.

문단 제목은 다음과 같이 표현한다.

# 첫 번째 단계 문단 제목
## 두 번째 단계 문단 제목
### 세 번째 단계 문단 제목

또한, 1단계와 2단계는 다음과 같은 문법도 사용가능하다.

첫 번째 단계 문단 제목
====================

두 번째 단계 문단 제목
---------------------

강조 문법은 두 단계가 존재한다.

*강조*, _강조_, **더 강조**, __더 강조__

일반적으로 첫 번째와 두 번째는 기울인 글씨, 세 번째와 네 번째는 굵은 글씨로 표현된다.

하이퍼링크는 다음과 같은 문법을 사용한다.

[예제 사이트](http://www.example.com), [예제 사이트](http://www.example.com "사이트 제목")

순서가 부여된 리스트를 만들기 위해서는 다음과 같은 문법을 사용한다.

1. 첫 번째
2. 두 번째
3. 세 번째

전부 다 같은 숫자를 넣어도 순서가 제대로 부여된다.

1. 첫 번째
1. 두 번째
1. 세 번째

순서없는 리스트는 다음과 같은 문법을 사용한다.

- 첫 번째
- 두 번째
- 세 번째

3. GitLab 마크다운 문법

마크다운 문법 도움말

4. 마크다운 장점

  • 읽고 쓰기 쉽고 빠르다.
  • 키보드 중심 작업이 가능하다.
  • 텍스트 기반이라 검색이나 버전관리가 용이하다.
  • 지원하는 소프트웨어나 서비스가 많다.

5. 마크다운 단점

  • 표준의 부재. 기본 문법 외에 확장 문법에 대한 표준이 없다.
  • 표나 이미지 추가가 어렵다.

6. 마크다운 도구

  • MarkdownPad
    • 윈도우용 마크다운 에디터
    • 실시간 뷰어. CSS 적용 가능
    • HTML & PDF 변환 (PDF 변환은 유료)
  • MacDown
    • 맥용 마크다운 에디터
    • 실시간 뷰어. CSS 적용 가능
    • HTML & PDF 변환

참고문서