Github Wiki에서 TOC 만들기

Github Markdown
💾 Etc
Publish Date:   2022-04-21
Word Count:   101
Read Times:   1 Min


종종 프로젝트를 하다보면 wiki의 크기가 커지는 경우가 많은데, 문서 가시성을 위해 wiki에서 TOC(Table Of Content, 목차)를 만드는 방법을 소개해보고자 한다.

repository wiki에 접속 후 sidebar 추가하기



아래의 형태로 원하는 항목 작성

# My menu
* [목차1][home]
* [목차2][techdocs]
* [목차3][usermanual]

[home]: https://github.com/myproject/wiki/목차1
[techdocs]: https://github.com/myproject/wiki/목차2
[usermanual]: https://github.com/myproject/wiki/목차3
  • 위의 코드가 이해가 안된다면 기존의 마크다운처럼 작성 후 변경 에디터로 코드를 변경하자: https://ecotrust-canada.github.io/markdown-toc/
    • 변경한 코드에서 <small> ... </small> 부분은 지워도 괜찮다.
Author: Ruby Kim
Link: http://ruby-kim.github.io
Reprint policy: All articles in this blog are used except for special statements CC BY 4.0 reprint policy. If reproduced, please indicate source Ruby Kim !
Github Markdown
Comments
  TOC