GitHub Wiki의 ToC 또는 사이드 바

GitHub Wiki의 ToC 또는 사이드 바

---

GitHub Wiki에서 ToC 또는 사이드 바 메뉴를 생성하려면 어떻게해야합니까?

나는 그것에 대한 언급을 보았고 백엔드가 그것을 지원하는 것처럼 보이지만 현재 GitHub 프로젝트에서 어떻게 수행합니까?

자동으로 페이지에있는 헤더를 기반으로하는 것이 가장 좋습니다.

이 링크는 모두 언급하지만 방법은 표시하지 않습니다.

• https://gist.github.com/379469- 일부 JavaScript 해킹

• https://github.com/blog/774-git-powered-wikis-improved-GitHub에서 언급 :

  "GitHub Wiki에는 바닥 글 및 사이드 바에 대한 문서화 기능이 거의 없습니다. 일부 git 기반 Wiki 작성자에게 익숙한 기능입니다. 새로운 Wiki 편집기를 사용하면 사이트에있는 바닥 글 및 사이드 바에 대한 제한된 웹 기반 편집이 가능합니다. "

---

솔루션이 작동하는 동안 GitHub의 웹 인터페이스를 사용하여 더 쉽게 수행 할 수있는 방법이 있습니다. _Sidebar및 / 또는 이라는 페이지를 간단히 만들 수 있습니다 _Footer.

에서 자세한 내용을 참조하십시오 멀티 레벨 Github에서 위키 사이드 바 메뉴 빌더 .

편집 원본 기사가 사라지고 캐시에서 찾을 수 없어 링크를 업데이트했습니다.

---

괜찮아. 이 내용을 올바르게 이해했는지 확인해 보겠습니다.

1. GitHub 위키를 복제합니다. (위키에 Git 섹션이 있습니다. 위키와 유사한 코드를 확인할 수 있습니다.)
2. 창조하다 _Sidebar.md
3. 일반 위키 페이지에서는 [[link]]사이드 바에 사용
4. 커밋하고 GitHub로 푸시 백

이 과정은 엉덩이에 고통입니다. 나는이“골룸”위키가 어떤 수용도 가지고 있다는 것에 놀랐다.

또한 : _Sidebar.md 따라서 모든 페이지에 대해 전역 적입니다 . 내 위키를 폴더로 구성해야하므로 페이지마다 다른 사이드 바를 정의 할 수 있습니다.

---

프로젝트의 위키에 있는 경우 사용자 정의 사이드 바 추가 링크가 있습니다. 그것을 클릭하십시오.

이제 다른 마크 다운 페이지를 편집하는 것처럼 편집 할 페이지가 있습니다. 목차를 만들려면 수동으로해야합니다. 자동화 된 방법은 없습니다 (2014 년 8 월 현재). 예를 들면 다음과 같습니다.

# My menu
* [Home][home]
* [Technical documentation][techdocs]
* [User manual][usermanual]

[home]: https://github.com/myproject/wiki/Home
[techdocs]: https://github.com/myproject/wiki/Technical-documentation
[usermanual]: https://github.com/myproject/wiki/User-manual

---

원래 질문은 사이드 바 (쉬움, 답변에서 해결됨) 또는 실제 목차 (답변 없음)를 만드는 것이 었습니다.

내가 말할 수있는 한 가지는 gollum 2.1 위키 구문은 [[_TOC_]]태그를 허용 하지만 GitHub 위키는 그것을 인식하지 못합니다 (아직?).

---

나는 이것이 골룸에README 묘사되어 있다고 생각합니다 . (헤더 및 사이드 바 섹션을 참조하십시오.)

기본적으로 페이지 콘텐츠가 포함 된 디렉토리에서 _footer.extand 를 만듭니다 _sidebar.ext.

---

방금 wiki git의 폴더 구조와 페이지를 기반으로 GitHub의 _Sidebar.md에 인덱스를 생성하는 Python 스크립트 를 만들었습니다 .

---

github 사용자가 사이드 바 메뉴를 쉽게 만들고 유지 관리 할 수 ​​있도록 npm 모듈 github-wiki-sidebar 를 구현했습니다 .

출처 및 결과 : https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

소스 페이지 (위키 관리자에 표시됨) :

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

결과 (맞춤형 주문 포함) :

• 집
• 설치
• 용법
  • 초기화 모드
  • 명령 줄 수정 자
• 로드맵

사전 요구 사항 :

• github wiki 저장소를 로컬로 복제합니다 (Wiki UI의 오른쪽 하단에 표시됨).

• github-wiki-sidebar 설치

  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g github-wiki-sidebar
  

위키 메뉴 생성 / 업데이트 :

• github.com 위키 관리자에서 새 페이지 생성 / 페이지 이름 변경

• 위키 저장소 폴더에서 github-wiki-sidebar 스크립트를 로컬에서 실행합니다.

  cd /path/to/<my-project-name>.wiki
  # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github
  github-wiki-sidebar --git-push
  

이 모듈을 사용하면 항목 순서, 범주 구분 기호, 메뉴 템플릿, 링크 형식 등을 포함한 마크 다운 출력을 사용자 지정할 수 있습니다.

참고 URL : https://stackoverflow.com/questions/9239588/toc-or-sidebar-in-github-wiki