ToC หรือ Sidebar ใน GitHub Wiki

88

ฉันจะสร้าง ToC หรือเมนูแถบด้านข้างใน GitHub Wiki ได้อย่างไร

ฉันเห็นบางคนพูดถึงมันและดูเหมือนว่าแบ็กเอนด์จะรองรับ แต่ฉันจะทำอย่างไรในโครงการ GitHub ปัจจุบัน

ควรอิงตามส่วนหัวที่ฉันมีในหน้าโดยอัตโนมัติ

ลิงก์เหล่านี้กล่าวถึงทั้งหมด แต่ไม่ได้แสดงวิธีการทำ:

  • https://gist.github.com/379469 - แฮ็ค JavaScript บางตัว

  • https://github.com/blog/774-git-powered-wikis-improved - GitHub กล่าวถึง:

    "GitHub Wikis มีความสามารถในการจัดทำเอกสารเล็กน้อยสำหรับส่วนท้ายและแถบด้านข้างซึ่งเป็นสิ่งที่ผู้เขียน Wiki ที่ใช้ git ของเราคุ้นเคยโปรแกรมแก้ไข Wiki ใหม่ช่วยให้คุณสามารถแก้ไขส่วนท้ายและแถบด้านข้างบนเว็บไซต์ได้อย่าง จำกัด "

github  wiki 
— Wolle
แหล่งที่มา
3
ฉันพัฒนา GitHub Wikifier: Git Hook ล่วงหน้าที่จะสร้างสารบัญทั้งหมดที่คุณต้องการ เพียงแค่เขียนเนื้อหาของคุณและปล่อยให้มันดำเนินต่อไป อาจคุ้มค่ากับการตรวจสอบ github.com/kuroir/GitHub-Wikifier
— MarioRicalde
— Ciro Santilli 郝海东冠状病六四事件法轮功
รหัสของ @MarioRicalde ย้ายไปที่github.com/hybridgroup/GitHub-Wikifier
— Jonny

คำตอบ:

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 ของ wiki ในกรณีที่คุณเป็นสูญเสียเป็นผมคุณจะต้องใช้ URL https://github.com/<username>/<projectname>.wiki.gitหรือ git@github.com:<username>/<projectname>.wiki.gitSSH
— NightOwl888
1
คำแนะนำโดยละเอียดเหล่านี้ค่อนข้างแย่ คืออะไร[[link]]? การใส่ URL ลงไปจะทำให้ URL ทั้งหมดปรากฏขึ้น
— Pithikos
3
@Pithikos เป็น Github Markdown พูด คำแนะนำไม่ได้มีไว้เพื่อสอนคุณ Markdown พวกเขาอยู่ที่นั่นเพื่ออธิบายแถบด้านข้าง
— nicerobot
2
@nicerobot และวิธีที่ดีที่สุดในการอธิบายบางสิ่งคือการใช้ตัวอย่างที่เป็นรูปธรรม ..
— Pithikos
26

เมื่อคุณอยู่ในวิกิพีเดียของโครงการของคุณที่มีการเชื่อมโยงเพิ่มแถบด้านข้างที่กำหนดเอง คลิกที่

ใส่คำอธิบายภาพที่นี่

ตอนนี้คุณมีหน้าที่คุณแก้ไขเหมือนกับที่คุณจะแก้ไขหน้าMarkdownอื่น ๆ ในการสร้างสารบัญคุณต้องทำด้วยตนเอง ไม่มีวิธีการอัตโนมัติ (ณ เดือนสิงหาคม 2014) ตัวอย่างเช่น:

# 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 wiki ของคุณ (มีส่วน Git ในวิกิคุณสามารถชำระเงินรหัสที่เหมือนวิกิของคุณได้)
  2. สร้าง _Sidebar.md
  3. ในหน้าวิกิปกติใช้[[link]]สำหรับแถบด้านข้าง
  4. ยอมรับและส่งกลับไปที่ GitHub

ขั้นตอนนี้ปวดตูด ฉันประหลาดใจที่วิกิ“ กอลลัม” นี้ได้รับการยอมรับ

นอกจากนี้: _Sidebar.mdดังนั้นจึงเป็นเรื่องของโลกสำหรับทุกหน้า ฉันจะต้องจัดระเบียบ wiki เป็นโฟลเดอร์ดังนั้นฉันจึงสามารถกำหนดแถบด้านข้างที่แตกต่างกันสำหรับหน้าต่างๆได้

— Wolle
แหล่งที่มา
2
ตามเอกสารคุณสามารถเพิ่มแถบด้านข้างที่แตกต่างกันสำหรับโฟลเดอร์ต่างๆ: "แถบด้านข้างมีผลต่อทุกหน้าในไดเรกทอรีและไดเรกทอรีย่อยใด ๆ ที่ไม่มีไฟล์แถบด้านข้างเป็นของตัวเอง" ดู: github.com/github/gollum
— Subfuzion
10

โปรดทราบว่าคำถามเดิมเกี่ยวกับการสร้างแถบด้านข้าง (ง่าย ๆ แก้ไขได้ในคำตอบ) หรือสารบัญจริง (ไม่ได้รับคำตอบ)

สิ่งหนึ่งที่ฉันสามารถพูดได้คือไวยากรณ์ gollum 2.1 wiki อนุญาตให้ใช้[[_TOC_]]แท็กได้ แต่วิกิ GitHub ไม่รู้จักสิ่งนั้น (ยัง?)

— เครื่องหมาย
แหล่งที่มา
4
คุณมีโชคบ้างไหม? นี่เป็นเรื่องน่าผิดหวังอย่างยิ่งที่มาจาก Trac ซึ่งสิ่งเหล่านี้ทำได้อย่างง่ายดาย
— jooks
ฉันคิดว่าคำตอบที่ดีกว่าสำหรับคำถามเดิมเกี่ยวกับวิธีสร้างสารบัญ "ตามส่วนหัวที่ฉันมีในหน้าโดยอัตโนมัติ" เป็นสิ่งที่เป็นไปไม่ได้ในขณะนี้ด้วย GitHub Wiki
— avernet
ขณะนี้เป็นปัญหาที่เปิดกว้าง (ขี้เกียจหาจำนวน) ที่มีคนแสดงความคิดเห็นเป็นร้อย ยังไม่มีคำตอบกลับจาก GitHub :(
— abalter
ปัญหาหลักของ GitHub ที่อ้างอิงถึงสิ่งนี้ ณ วันที่ 2017-01-19 คือ: 1. Markdown - สารบัญ 2. แทรก
— ckib16
4

ผมคิดว่านี่คือการอธิบายไว้ในกอลลัม README(ดูส่วนหัวและแถบด้านข้าง)

โดยพื้นฐานแล้วคุณสร้าง_footer.extและ_sidebar.extในไดเร็กทอรีที่มีเนื้อหาของเพจ

— Seandavi
แหล่งที่มา
2

ฉันได้ติดตั้ง npm module github-wiki-sidebarเพื่อช่วยให้ผู้ใช้ github สร้างและดูแลเมนูแถบด้านข้างได้อย่างง่ายดาย

ที่มาและผลลัพธ์: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

หน้าต้นทาง (ตามที่แสดงในผู้ดูแลระบบ Wiki):

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

สร้าง / อัปเดตเมนูวิกิของคุณ:

  • สร้างเพจใหม่ / เปลี่ยนชื่อเพจบนผู้ดูแลระบบ wiki github.com ของคุณ

  • เรียกใช้สคริปต์ github-wiki-sidebar ในโฟลเดอร์ที่เก็บ wiki ของคุณ

    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. สร้างเอกสารให้พิมพ์ AsciiDoc แทน Markdown
  2. แทรก:toc:ที่จุดเริ่มต้นของเอกสาร
— Dogweather
แหล่งที่มา
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.