깃허브에 올라온 md파일을 읽다보면 목차가 생성되어있는 것을 볼수가 있다. 이걸 자동으로 만들어주는 라이브러리가 있지만.. 보통은 그냥 작성한다. 그렇게 어렵지않다.
일단 우리가 보통 마크다운문서를 작성할 때는 #
의 갯수에 따라 타이틀1, 타이틀2, 타이틀3 을 구분하여 사용할 수 있다.
이게 타이틀 역할도 하지만 이게 앵커 역할도 한다.
아래를 보면 ### 섹션 이라고 작성되어있는 부분이 있다. 이걸 상단에서 [섹션1](#섹션1)
의 형태로 불러올 수가 있다.
[]()
이건 하이퍼링크를 달때 사용하는 표현인데 오른쪽엔 링크 왼쪽엔 보여질 텍스트가 들어가는 것이다. 이때 오른쪽 링크의 값을 가지고 앵커를 찾아간다.
## 목차
- [섹션1](#섹션1)
- [섹션2](#섹션2)
### 섹션1
이곳은 섹션1입니다.
### 섹션2
이곳은 섹션2입니다.
위 부분 처럼 타이틀이 띄어쓰기도없이 나타나는 경우는 위와 동일하게 앵커를 따로 만들필요가 없다. ### 섹션1 자체가 앵커역할을 할 수 있기 때문이다.
하지만 아래 처럼 띄어쓰기가 있는 경우는 달라진다.
타이틀이 ## Section 1 에는 띄어쓰기가 있다. 이 앵커를 찾아가려면 위에있는 URL에 공백에 -
를 표시해준다.
## Table of Contents
- [Section 1](#section-1)
- [Subsection 1.1](#subsection-1-1)
- [Subsection 1.2](#subsection-1-2)
- [Section 2](#section-2)
- [Subsection 2.1](#subsection-2-1)
- [Subsection 2.2](#subsection-2-2)
## Section 1
### Subsection 1.1
### Subsection 1.2
## Section 2
### Subsection 2.1
### Subsection 2.2
- 링크가 들어가는 부분에는 띄어쓰기가 들어갈 수 없다.
[]
안에 띄어쓰기대신-
를 사용한다. :
이나()
같은 것들은()
안에서는 생략하면 된다.
아래 예시를 참고하자
Index
123
123
123
123
123
123
123
123
123
- 230410 : 초안작성
- 230420 : 예제 추가
- 230510 : 특수문자 및 띄어쓰기 내용 추가