Post

[markdown] 마크다운 문법

블로그 작성하면서 헷갈렸던 부분이 있으면 여기 하나씩 적어야겠다. 매번 같은 부분에서 헤맨다.

마크다운에서의 내부 링크 문법

마크다운에서는 내부링크를 통해 내부 문서로 향하는 링크를 걸 수 있다. 찾아보면서 알게 된 사실이지만, 이것을 ‘네임드 앵커’라고 하는 듯 하다.

1
[표시될 문구](#링크를-걸-제목)

이 기능을 활용하면 목차를 만들 수도 있고, 참조할 만한 내용이 있을 때 그곳으로 향할 수 있도록 링크를 걸수도 있다.
그런데 이 내부링크가 제대로 작동하기 위해서는 조건을 맞추어 링크를 걸어야 한다.
조건은 다음과 같다.

  1. 공백문자(‘ ‘)는 ‘-‘로 표기 공백문자가 연속으로 여러 개 있을 경우, 공백문자의 개수만큼 ‘-‘를 써준다.
  2. 내부링크는 제목(#, ##, ###…)에만 걸 수 있다.
    목적지가 될 제목의 #의 수는 제한이 없으나 링크를 연결할 때에는 #을 하나만 작성해야 한다.
  3. 영어는 소문자로만 표기
  4. 특수문자는(‘.’, ‘,’, ‘(‘,’)’ 등) ‘-‘를 제외하고 모두 무시한다.

또 내가 모르는 다른 제한이 있을 수도 있다. 이럴 때는 GitHub에서 제공하는 내부링크 기능을 이용하면 좋다.
마크다운으로 작성된 문서를 GitHub에서 열람할 때 제목에 마우스를 hover하면 제목으로 이동하는 링크가 왼쪽에 표시되는데, 이 링크대로 작성하면 올바로 동작하는 링크를 걸 수 있다~!
링크는 이렇게 표시된다.
링크로 이동한 다음에 주소창에서 확인할 수 있는 url에서 내가 원하는 링크부분만 복사해서 사용하면 된다.

다음은 블로그를 작성하면서 오류가 발생했던 내부링크를 이용한 예시이다.

1
2
3
4
5
6
7
8
9
10
11
12
13
<!--예제 1-->
## 8장 : OCP - 개방-폐쇄 원칙

[OCP : 개방-폐쇄 원칙(Open-Closed Principle)](#8장--ocp---개방-폐쇄-원칙) <!--(O)-->
[OCP : 개방-폐쇄 원칙(Open-Closed Principle)](#8장-:-ocp---개방-폐쇄-원칙) <!--(X)-->


// 예제 2
## OCP(Open-Closed Principle, 개방-폐쇄 원칙)

[OCP](#ocpopen-closed-principle-개방-폐쇄-원칙) <!--(O)-->
[OCP](#OCP(Open-Closed Principle, 개방-폐쇄 원칙)) <!--(X)-->

참고로, 내부링크가 위치하는 곳은 어디든 상관 없다. 즉, 링크의 목적지가 링크보다 위에 있어도, 아래에 있어도 모두 작동한다.

주석

방금 위의 챕터를 쓰면서 몰랐던 사실인데, 마크다운에서 주석 문법은 다음과 같다.

1
2
3
<!--
주석으로 작성하고 싶은 내용
-->
This post is licensed under CC BY 4.0 by the author.

Comments powered by Disqus.