GitHub Wiki의 ToC 또는 사이드 바

87

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

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

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

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

github  wiki 
— 월레
소스
3
필자는 GitHub Wikifier : 필요한 모든 목차를 생성하는 사전 커밋 Git Hook을 개발했습니다. 콘텐츠를 작성하고 인계하십시오. 확인할 가치가 있습니다. github.com/kuroir/GitHub-Wikifier
— MarioRicalde
— Ciro Santilli 郝海东 冠状 病 六四 事件 法轮功
@MarioRicalde의 코드로 이동 github.com/hybridgroup/GitHub-Wikifier
— 조니

답변:

76

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

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

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

— Nicerobot
소스
7
@CodeSherpa 그들은에서 접근 https://github.com/[user]/[repo]/wiki/_Sidebar/_edit하고https://github.com/[user]/[repo]/wiki/_Footer/_edit
— nicerobot
1
이 기사는 훌륭했지만 위키의 URL을 얻는 방법에 대한 잘못된 (또는 오래된) 정보를 제공합니다. 나처럼 길을 잃은 경우 URL https://github.com/<username>/<projectname>.wiki.git또는 SSH 를 사용해야합니다 git@github.com:<username>/<projectname>.wiki.git.
— NightOwl888 2014
1
이러한 자세한 지침 은 매우 좋지 않습니다. 무엇입니까 [[link]]? 거기에 URL을 넣으면 전체 URL이 표시됩니다.
— Pithikos 2014-08-12
3
@Pithikos Github Markdown이 말합니다. 마크 다운을 가르치기위한 지침은 없습니다. 그들은 사이드 바를 설명하기 위해 있습니다.
— nicerobot 2014-08-13
2
@nicerobot 뭔가를 설명하는 가장 좋은 방법은 구체적인 예를 사용하는 것입니다 ..
— Pithikos
26

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

여기에 이미지 설명 입력

이제 다른 마크 다운 페이지를 편집하는 것처럼 편집 할 페이지가 있습니다. 목차를 만들려면 수동으로해야합니다. 자동화 된 방법은 없습니다 (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
— 피티 코스
소스
25

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

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

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

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

— 월레
소스
2
문서에 따르면 다른 폴더에 대해 다른 사이드 바를 추가 할 수 있습니다. "사이드 바는 디렉토리의 모든 페이지와 자체 사이드 바 파일이없는 하위 디렉토리에 영향을 미칩니다." 참조 : github.com/github/gollum
— Subfuzion
10

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

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

— 표
소스
4
행운이 있었나요? 이 모든 일이 쉽게 수행되는 Trac에서 온 것은 매우 실망 스럽습니다.
— jooks dec
"페이지에있는 헤더를 기반으로 자동으로"목차를 만드는 방법에 대한 원래 질문에 대한 더 나은 답변은 현재 GitHub Wiki로는 불가능하다고 생각합니다.
— avernet
이것은 현재 수백 명의 사람들이 언급 한 공개 된 문제 (수를 찾기에는 너무 게으름)입니다. 아직 GitHub에서 돌아온 단어가 없습니다 :(
— abalter
2017년 1월 19일 현재 동을 참조 주요 GitHub의 문제는 다음과 같습니다 1. 마크 다운 - 목차 2. 삽입 README.md 같은 렌더링 인하 파일에 대한 내용 TOC의 자동 생성 된 테이블
— ckib16
4

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

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

— Seandavi
소스
2

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

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

— 아타나 사
소스
0

GitHub는 문서 목차를 자동 생성합니다.

  1. Markdown 대신 문서 유형 AsciiDoc을 만드십시오.
  2. :toc:문서 시작 부분에 삽입 합니다.
— Dogweather
소스
당사 사이트를 사용함과 동시에 당사의 쿠키 정책과 개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.