카테고리 없음

마크다운 문서 편집 문법

까칠하지 않은 까시 2020. 2. 5. 11:55

마크다운 문서 편집 문법

마크다운(Markdown) 이란, 간단한 TEXT Editor 에서 몇가지 특수문자만을 사용하여, 쉽고 빠르게 구조화된 문서를 만들 수 있는 방법이다.
주로, github 에 올리는 README.md 파일을 편집할 때 사용한다고 한다.

마크다운을 이용하여 간단한 HTML 형식의 문서를 매우 쉽고 직관적으로 작성할 수 있다.

** 주의사항 **
마크다운 문법은 표준이 정해져 있는 것이 아니기 때문에, viewer 마다 지원하는 기능이 서로 다를 수 있다.

(아니, 거의 대부분이 서로 다른 것 같다.)

기본 문법

문서의 제목과 같은 것은 1행의 문자를 입력하고 곧바로 다음 행에, === 를 3개 이상 입력함으로써, Title 과 같이 만들 수 있다.
그리고 --- 를 3개 이상 입력하는 것으로 그것 보다 1 단계 작은 제목을 만들 수 도 있다.

또한 그 외에 # 문자를 이용해서도 HTML 의

..

의 태그를 만들 수 있다.

#가 한개라면

, #가 6개 라면

태그가 된다.

인용문의 표시

E-mail 형식에서 사용되고 있는 > 문자를 이용하여 reply 와 같이 구분하여 표시할 수 도 있다.

note : 이것은 인용문 처럼 표시된다.
기본적으로 HTML과 같이 1개의 줄바꿈은 무시된다. 2개 이상의 줄바꿈이 있을 때

태그 처럼 사용된다.

목록의 표시

순서가 있는 목록 (

  • 태그) 는, 숫자와 마침표, *, +, - 의 문자를 사용하여 목록을 표시할 수 있다.
공백문자와 조합하여 LEVEL 을 조정한다. 각 기호들을 섞어 쓰더라도 무관하다 (레벨 변경이 없다.)

  1. 하나

  2. 둘

  3. 셋

    3-1. 과 같은 형태는 사용할 수 없다. 즉, 순서가 있는 목록에서 indent 는 사용할 수 없다.

  • 첫번째
  • 두번째
    • 두번째 레벨
      • 세번째 레벨
  • 세번째

소스코드의 입력 (코드블럭)

소스코드를 입력할 때에는, 모든 행에 tab(또는 space 4개)을 넣어 준다.

 태그처럼 사용할 수 있다.
맨 처음 한 줄을 공백 문자열로 띄어 주어야만 한다.
THIS IS SOURCE CODE.
  <HTML>
  <head> </head>
  <body> </body>
</HTML>

function javascript() {
 var test = 12345;
}

그리고, ` 문자를 세개 이상 입력해서 코드 블럭을 만들 수 도 있다고 한다.

여기서 부터는 소스코드 끝낼 때에도 ``` 를 세개 입력해서 끝낸다.

수평선 (문단의 분리)

수평선으로 구획을 나누는 것은 --- 를 세개 이상 쓰거나, *** 를 3개 이상 쓰거나, 또는

TAG 를 직접 입력해서 구획을 나눌 수 있다.

강조 표시

단어의 앞 뒤에 공백없이 * 을 붙여 단어를 강조할 수 있다.
* 또는 _ 를 1개만 붙이면, Italic 표시가 되고, 2개 이상 붙이면 BOLD체 문자열을 표시한다.
~ 를 두개 붙이면

cancel

과 같이 취소선 을 만들어 준다.

그림 삽입

! 와 [ ] () 를 이용하여 그림을 입력할 수 있는 것 같다.

image title

![alt text](Image_URL)

이러한 형식으로 이미지의 대표문자열과 URL 을 입력해 주면 된다.

줄바꿈

HTML과 같은 형태로 문서가 구성되기 때문에, 하나의 줄바꿈은 무시된다.
그래서 강제로 줄바꿈을 하려면, 2개 이상의 행을 입력하여 문단을 분리 (

) 하거나 띄어 쓰기를 하면 된다고 하는데..

내가 사용하는 ATOM 의 플러그인 에서는 SPACE 3개 연속 입력하는 것으로는 효과가 없는 듯 하다. 그럴 땐
태그를 직접 입력하는 것으로
강제로 줄바꿈을 사용할 수 있다.

링크

일반적으로 URL 을 그대로 입력한 경우, 자동으로 Link 가 생성된다.
이 문서의 출처는 https://gist.github.com/ihoneymon/652be052a0727ad59601 여기에서 학습하여 내가 직접 정리한 것이다.

그리고, [ ] 문자를 이용하여 대표문자열 만으로도 사용할 수 도 있다.
예를 들면, [google] 이라고 입력하고, 그 아래에 1줄 이상 띄고

[google]:http://google.com

과 같이 입력해 두면,
이렇게 google 이라는 키워드에 링크가 연결된다.

문단이 여러개로 나뉘어져 있어도 링크는 문서를 통틀어 한꺼번에 모아 놓을 수 있는 것 같다.
그렇기 때문에, 관련 링크들을 문서의 맨 끝에 몽땅 모아 둘 수도 있을 것 같아 편리하다.

저작자표시