GitHub 위키에서 어떤 종류의 목차를 어떻게 만듭니 까?

GitHub 위키에서 어떤 종류의 목차를 어떻게 만듭니 까?

---

여기를 보면 : http://en.wikipedia.org/wiki/Stack_Overflow

링크 중 하나를 클릭하면 페이지의 특정 섹션으로 이동하는 작은 "콘텐츠"섹션이 있음을 알 수 있습니다.

GitHub 위키에서 어떻게하나요? Markdown 또는 그들이 사용하는 무엇이든?

---

Markdown Cheatsheet 의 목차에 잘 설명되어 있습니다.

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

GitHub Markdown 파일의 헤더 위로 마우스를 가져 가면 왼쪽에 간단한 링크가 표시되며 해당 링크를 사용할 수도 있습니다. 해당 링크의 형식은 <project URL#<header name>입니다. 는 <header name>모두 소문자 여야합니다.

---

가능한 (반자동) 솔루션 중 하나는 Eugene Kalinin의 github-markdown-toc. 이 도구는 기본적으로 README.md파일을 처리하고 #의 제목을 잡아내어 TOC를 만듭니다.

1. https://github.com/ekalinin/github-markdown-toc 스크립트 다운로드

2. README.md스크립트에 피드 (Eugene의에서 언급 한대로 README.md)

   고양이 README.md | bash github-markdown-toc

3. 생성 된 TOC를 잘라내어 붙여넣고 README.md파일 상단에 배치 합니다.

이 bash구현은 Linux에서만 작동합니다 (내가 말할 수있는 것).

참고로 golang 구현이 있으며 작업하기가 더 번거 롭습니다 .

---

https://github.com/jonschlinkert/markdown-toc

• git clone your-repo.wiki.git( 위키 복제 .wiki직전 .git에 추가
• npm i -g markdown-toc
• <!-- toc -->위키의 마크 다운에 삽입 (대소 문자 구분)
• markdown-toc -i my-wiki-markdown.md( -i제자리에서 편집합니다)
• 이익

---

업데이트 : 이제 https://github.com/thlorenz/doctoc 가 더 인기가 있다고 생각 합니다.

---

현재 는 마크 다운 구문 ( ) 을 사용하여이를 수행 할 수 없습니다.md . 일부 아이디어를 나열하는 렌더링 된 마크 다운 파일에서 목차 TOC 를 자동으로 생성하는 것에 대한 비공식적 인 논의 가 진행 README.md중입니다.

그러나 다음과 같은 몇 가지 다른 해결 방법이 있습니다.

• AsciiDoc이 의견의 제안에 따라 대신 사용하십시오 . 예를 들면 :

  :toc: macro
  :toc-title:
  :toclevels: 99
  # Title
  
  toc::[]
  
  ## A
  
  ### A2
  
  ## B
  
  ### B2
  

  littlebits/react-popover( README.adoc) 에서 예제를 확인하십시오 .

• 온라인 목차 생성기 ( raychenon / play-table-of-contents )

• arthurhammer / github-toc-GitHub 저장소에 목차 를 추가하는 브라우저 확장

---

Markdown 을 고수 할 위치가 아니라면 다음과 같이 할 수 있습니다.

• 에 GitHub의 / 위키 : 전환 마크 다운을 에 미디어 위키 . __TOC__구문을 사용하십시오 . 샘플을 참조하십시오 .
• 에 GitHub의 / REPO : 전환 마크 다운을 에 AsciiDoc . :toc:구문을 사용하십시오 . 데모를 참조하십시오 .

그러나 GitHub / repo의 Markdown 파일을 사용 하면 Wikipedia 에서와 같이 GitHub 페이지 에서 가져올 수 있습니다.

• 때 지킬이 활성화되고, 그것은 생성 GitHub의 페이지를 사용하여 Kramdown을 기본적를
• Kramdown 은 Table Of Content. {:toc}구문을 사용하십시오 . 설명을 참조하십시오 .

---

github는 TOC직접 사용할 수 없기 때문에 다른 대안이 있습니다.

온라인 도구 를 통해 자동으로 TOC를 생성 할 수 있습니다 .

GitHub Markdown 또는 Wiki Online에서 TOC 목차 생성

또는 로컬 도구 를 통해 :

github-markdown-toc

---

헤더에 대한 toc를 생성하는 편집 모드 "MediaWiki"를 선택할 수 있습니다.

== First ==

== Second ==

---

나에게 가장 간단한 해결책은 (항상 node.js 서버가 설치되어 있고 npm에 npx가 있기 때문에) npx markdown-toc를 실행하는 것 입니다. 이 작업에 대한 가장 인기있는 솔루션 중 하나 인 것 같습니다.

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

산출:

참고 URL : https://stackoverflow.com/questions/18244417/how-do-i-create-some-kind-of-table-of-content-in-github-wiki