หากคุณดูที่นี่: http://en.wikipedia.org/wiki/Stack_Overflow
คุณจะสังเกตเห็นว่ามีส่วน "เนื้อหา" เล็กน้อยหากคุณคลิกที่ลิงก์ใดลิงก์หนึ่งระบบจะส่งคุณไปยังส่วนเฉพาะในหน้านั้น
ฉันจะทำสิ่งนี้ใน GitHub wiki ได้อย่างไร ด้วย Markdown หรืออะไรก็ตามที่พวกเขาใช้?
คำตอบ:
มันจะแสดงให้เห็นอย่างในสารบัญของMarkdown Cheatsheet
##### Table of Contents
[Headers](#headers)
[Emphasis](#emphasis)
...snip...
<a name="headers"/>
## Headers
หากคุณวางเมาส์เหนือ Header ในไฟล์ GitHub Markdown คุณจะเห็นลิงค์เล็ก ๆ ทางด้านซ้ายคุณสามารถใช้ลิงก์นั้นได้ <project URL#<header name>รูปแบบสำหรับการเชื่อมโยงที่เป็น <header name>จะต้องเป็นกรณีที่ต่ำกว่า
__TOC__ได้โดยตรง เห็นได้ชัดว่าตรรกะของการสร้างอัตโนมัติอยู่ที่นั่น แต่ดูเหมือนว่าฟังก์ชันการทำงานจะไม่ถูกเปิดเผยในรูปแบบการแก้ไข Markdown ค่อนข้างโชคร้าย มาเริ่มส่งคำขอคุณสมบัติสำหรับมันและบางทีพวกเขาอาจจะเปิดใช้งาน
#Headersแทน#headers. ฉันคิดว่าคำตอบของคุณพิมพ์ผิด บางทีคุณสามารถเพิ่มคำตอบของคุณข้อมูลนี้
หนึ่งที่เป็นไปได้ (กึ่งอัตโนมัติ) github-markdown-tocการแก้ปัญหาคือยูคาฯ เครื่องมือนี้จะREADME.mdบีบอัดไฟล์ของคุณเป็นหลักและแยก#ส่วนหัวออกเพื่อสร้าง TOC
ป้อนREADME.mdสคริปต์ของคุณ(ตามที่ระบุไว้ใน Eugene's README.md)
แมว README.md | ทุบตี github-markdown-toc
ตัดและวาง TOC ที่สร้างขึ้นและวางไว้ที่ด้านบนของREADME.mdไฟล์ของคุณ
โปรดทราบว่าbashการใช้งานนี้ใช้ได้กับ Linux เท่านั้น (จากสิ่งที่ฉันบอกได้)
โปรดทราบว่ามีการใช้งาน golang และอาจเป็นเรื่องยุ่งยากในการทำงาน
เนื่องจาก github ไม่สามารถใช้งานTOCได้โดยตรง แต่เรามีทางเลือกอื่น
คุณสามารถสร้าง TOC โดยอัตโนมัติผ่านเครื่องมือออนไลน์:
สร้างสารบัญ TOC จาก GitHub Markdown หรือ Wiki Online
หรือผ่านเครื่องมือท้องถิ่น:
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เป็นที่นิยมมากขึ้น
ขณะนี้ยังไม่สามารถทำได้โดยใช้ไวยากรณ์ markdown ( .md) มีการอภิปรายอย่างไม่เป็นทางการเกี่ยวกับการสร้างสารบัญ TOC โดยอัตโนมัติในไฟล์มาร์กดาวน์ที่แสดงผลREADME.mdซึ่งแสดงรายการแนวคิดบางส่วน
อย่างไรก็ตามมีวิธีแก้ปัญหาอื่น ๆ เช่น:
ใช้AsciiDocแทนตามคำแนะนำจากความคิดเห็นนี้ ตัวอย่างเช่น:
:toc: macro
:toc-title:
:toclevels: 99
# Title
toc::[]
## A
### A2
## B
### B2
ตรวจสอบตัวอย่างที่littlebits/react-popover(README.adoc )
Online Table Of Content Generator ( raychenon / play-table-of-contents )
หากคุณไม่อยู่ในสถานะที่จะยึดติดกับMarkdownคุณสามารถทำได้ดังนี้:
อย่างไรก็ตามการใช้ไฟล์MarkdownในGitHub / repoคุณสามารถดาวน์โหลดได้จากหน้า GitHubเช่นในWikipedia
- เมื่อเปิดใช้งานJekyllจะสร้างหน้า GitHubโดยใช้Kramdownตามค่าเริ่มต้น
- Kramdownมาพร้อมกับ
Table Of Content. ใช้{:toc}ไวยากรณ์ ดูคำอธิบาย
หากคุณใช้Visual Studio Codeมีส่วนขยายที่ใช้งานง่ายชื่อMarkdown All in Oneที่สามารถสร้าง TOC สำหรับไฟล์. md ใด ๆ ได้ในทันที
เพียงเปิด Command Palette ( Ctrl-Shift-P) ->Markdown: Create Table of Contents
เคล็ดลับเพิ่มเติมคุณอาจต้องการปิด "การอัปเดต TOC อัตโนมัติในการบันทึก" โดยใช้
"markdown.extension.toc.updateOnSave": false,
ในการตั้งค่า Visual Studio ของคุณ (Command Palette -> Preferences: Open Settings (JSON))
คุณสามารถเลือกโหมดแก้ไข "MediaWiki" ซึ่งจะสร้าง toc สำหรับส่วนหัวเช่น
== First ==
== Second ==
เนื่องจาก github มีวิธีสร้างแอตทริบิวต์ id = ".. " ใน h1, h2, h3 และอื่น ๆ ... ส่วนหัวในเวอร์ชัน html หลังจากประมวลผล Markdown (ตัวอย่างเช่น Bitbucket ใช้รูปแบบที่แตกต่างกันเล็กน้อยของหัวเรื่อง sluggifying id = "slug") มีประโยชน์อย่างยิ่งที่จะไม่ต้องสร้างล้อใหม่และใช้ไลบรารีที่ออกแบบกระบวนการนี้แบบย้อนกลับ
ฉันพบไลบรารีที่ค่อนข้างดีสำหรับงานนี้ชื่อmarkdown-toc markdown-toc
สำหรับฉันดูเหมือนว่าจะเป็นทางออกที่ดีที่สุดเพราะฉันมักจะติดตั้งโหนดบนเครื่องของฉัน
เพียงแค่รันnpx markdown-toc -i file.md
และดูเหมือนว่ามันเป็นหนึ่งในเครื่องมือยอดนิยมสำหรับงานนี้ - อย่างน้อยก็ในระบบนิเวศ node.js
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
เอาท์พุท:
