Dev-Tino 8주차(1):: 마크다운 문법 조사
작은 프로젝트를 위해 Github을 사용한 적이 있다. 좋은 기회였다.
Github과 Github Action의 사용법을 익히기 위한 프로젝트로 프로젝트의 주제는 자유롭게 택할 수 있었으나, 프로젝트의 소개와 내용만큼은 Readme 파일에 작성해야 했다.
.README 파일
Github 프로필, 혹은 Repository에 대한 설명을 담기 위한 가이드라인 겸 안내문이다. 일반적으로 프로젝트에 대한 정보가 담겨있다. 프로젝트에 대한 설명뿐만 아니라 사용 방법, 라이센스 등을 담고 있는 경우도 많다.
리드미 파일은 프로그램을 만들 때에 삽입하면 사용자의 돕는다. 그리고 이 리드미 파일을 잘 작성하기 위해서는 마크다운 언어에 대해 알아야만 한다.
마크다운
텍스트 기반의 마크업 언어(*태그 등을 이용하여 문서나 데이터의 구조를 명기하는 언어의 한 가지. 일반적으로 데이터를 기술하는 정도로만 사용된다.), 2004년 존 그루버에 의해 만들어졌다. 쉽게 쓰고 읽을 수 있으며 HTML로의 변환이 가능하다. 특수 기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 직관적으로 인식할 수 있다.
마크다운이 최근 각광받기 시작한 것은 깃헙 덕분이다. 깃헙의 저장소Repository에 관한 정보를 기록하는 README. md는 깃헙을 사용하는 사람이라면 누구나 가장 먼저 접하게 되는 마크다운 문서였다. 마크다운을 통해서 설치 방법, 소스코드 설명, 이슈 등을 간단하게 기록하고 가독성을 높일 수 있다는 강점이 부각되며 점점 여러곳으로 퍼지게 되었다.
마크다운의 장/단점
장점
- 간결하다.
- 별도의 도구 없이 작성 가능하다.
- 다양한 형태로 변환 가능하다.
- 텍스트(Text)로 저장되기 때문에 용량이 적어 보관이 용이하다.
- 텍스트파일이기 때문에 버전 관리 시스템을 이용하여 변경 이력을 관리할 수 있다.
- 지원하는 프로그램과 플랫폼이 다양하다.
단점
- 표준이 없다
- 표준이 없기 때문에 도구에 따라 변환 방식이나 생성물이 다르다
- 모든 HTML 마크업을 대신하지 못한다.
마크다운의 사용법 (문법)
1. 헤더
큰제목: 문서 제목
This is an H1
=============
작은제목: 문서 부제목
This is an H2
-------------
글머리: 1~6까지만 지원
# This is a H1
## This is a H2
### This is a H3
#### This is a H4
##### This is a H5
###### This is a H6
헤더(제목), 부제목, 글머리는 각각 ‘====’, ‘——-’, ‘#..’을 사용한다. H1, H2의 경우 아래에 회색 선이 생긴다.
2. 인용
인용
> This is a first blockqute.
> > This is a second blockqute.
> > > This is a third blockqute.
이 때, 안에 다른 마크다운 요소를 포함하여 다음과 같이 쓸 수 있다::
3. 목록
순서 있는 목록(번호)
이 때, 어떤 번호를 입력하더라도 순서는 내림차순으로 정의된다는 점이 인상깊게 볼 점이다.
순서 없는 목록(글머리 기호 *, +, - 지원)
혼합 사용이 가능하다.
4. 코드
들여쓰기
4개의 공백 또는 하나의 탭으로 들여쓰기를 만나면 변환되기 시작하여 들여쓰지 않은 행을 만날때까지 변환이 계속된다.
이 때, 한 줄을 띄어쓰지 않으면 인식이 제대로 되지 않는다.
코드 블럭
코드 블럭은
<pre><code>{code}</code></pre>
코드 블럭 코드(‘’```‘’)
두 가지 방법이 존재한다.
또, Github에서는 코드 블럭 코드 (‘’```‘’) 시작점에 사용하는 언어를 선언하여 문법 강조(*Syntax highlighting, 식별자 추가, 색 추가)가 가능하다.
5. 수평선
수평선을 나타내는 종류는 다음과 같다::
* * *
***
*****
- - -
---------------------------------------
모두 회색 선이 그인다.
6. 링크
7. 강조
문장 중간에 사용할 경우에는 띄어쓰기를 하는 것이 좋다. *이 한 개라면 이탤릭, 두 개일때에는 볼드, __<는 언더스코어, ~~(물결표 두 개로 내용을 감쌈)는 캔슬라인을 지원한다.
8. 사진
Github의 경우, 이렇게 하지 않고 사진을 가져오는 것만으로도 다음과 같이 코드를 작성해주는 것을 확인했다. Alt 설명 추가에만 신경쓰면 될 듯. 사이즈 조절 기능은 없으므로, <img width=“” height=“” /> 를 이용한다.
9. 줄바꿈
3칸 이상 띄어쓰기를 하면 줄이 바뀐다.
마크다운은 프로그래밍/Git저장소, velog와 티스토리 등의 블로그, 이슈 트래커에서 주로 사용된다.
마크다운을 쉽게 작성하는 법
문법을 외우고 활용하고는 있지만 마음에 들지 않을 때가 있을 수 있다. 문법을 작성하는 데에 오랜 시간이 걸릴 수도 있고 말이다.
그럴 때에는 ‘마크다운 에디터’를 사용해보자. 비슷한 고민을 한 이들이 많은 에디터를 만들어두었다.
마크다운 에디터를 검색했을 때 최상단에 뜨는 것은 Stack Edit이다.
Start Edit을 누르면 다음과 같은 에디터 화면이 출력된다.
[참고 자료]
-https://gist.github.com/ihoneymon/652be052a0727ad59601
- 카테고리
- #기타
댓글 0
추천 포스트
