Làm cách nào để tạo một số loại mục lục trong wiki GitHub?

Nếu bạn xem ở đây: http://en.wikipedia.org/wiki/Stack_Overflow

Bạn sẽ nhận thấy có một phần "Nội dung" nhỏ, nếu bạn nhấp vào một trong các liên kết, nó sẽ đưa bạn đến một phần cụ thể trên trang.

Làm cách nào để thực hiện việc này trong GitHub wiki? Với Markdown hoặc bất cứ điều gì họ sử dụng?

Nó là độc đáo thể hiện trong Table of Contents của Markdown Cheatsheet .

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

Nếu bạn di chuột qua Header trong tệp GitHub Markdown, bạn sẽ thấy một liên kết nhỏ đơn giản ở bên trái của nó, bạn cũng có thể sử dụng liên kết đó. Định dạng cho liên kết đó là <project URL#<header name>. Tất cả <header name>phải là chữ thường.

Một giải pháp khả thi (bán tự động) là của Eugene Kalinin github-markdown-toc. Về cơ bản, công cụ này sẽ xử lý README.mdtệp của bạn và tóm tắt #các tiêu đề để tạo TOC.

1. Tải xuống tập lệnh https://github.com/ekalinin/github-markdown-toc

2. Cung cấp cho bạn README.mdtập lệnh (như đã lưu ý trong Eugene's README.md)

   con mèo README.md | bash github-markdown-toc

3. Cắt và dán TOC đã tạo và đặt nó ở đầu README.mdtệp của bạn

Lưu ý rằng bashtriển khai này chỉ hoạt động trên Linux (theo những gì tôi có thể nói).

Cũng cần lưu ý thêm, có một cách triển khai golang và có lẽ sẽ gặp nhiều rắc rối hơn khi làm việc.

Vì github không thể sử dụng TOCtrực tiếp, nhưng chúng tôi có các lựa chọn thay thế khác.

Bạn có thể tự động tạo TOC thông qua công cụ Trực tuyến:

Tạo Mục lục TOC từ GitHub Markdown hoặc Wiki Online

hoặc qua công cụ Địa phương:

github-markdown-toc

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

• git clone your-repo.wiki.git(thêm .wikiquyền trước .gitđể sao chép wiki
• npm i -g markdown-toc
• Chèn <!-- toc -->(phân biệt chữ hoa chữ thường) trong phần đánh dấu wiki của bạn
• markdown-toc -i my-wiki-markdown.md( -isẽ chỉnh sửa tại chỗ)
• Lợi nhuận

Cập nhật: Tôi nghĩ có lẽ https://github.com/thlorenz/doctoc bây giờ phổ biến hơn.

Hiện tại, không thể thực hiện việc đó bằng cú pháp markdown ( .md). Đang có cuộc thảo luận không chính thức về việc tự động tạo mục lục TOC trên các tệp đánh dấu được hiển thị như README.mdliệt kê một số ý tưởng.

Tuy nhiên có một số cách giải quyết khác như:

• Sử dụng AsciiDocthay thế theo gợi ý từ nhận xét này . Ví dụ:

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

  Kiểm tra ví dụ tại littlebits/react-popover( README.adoc) .

• Trực tuyến Bảng Trong Generator Content ( raychenon / play-table-of-nội dung )

• arthurhammer / github-toc - tiện ích mở rộng trình duyệt thêm mục lục vào kho lưu trữ GitHub

Nếu bạn không ở vị trí để gắn bó với Markdown , bạn có thể làm như dưới đây:

• trên GitHub / wiki : chuyển Markdown sang MediaWiki . Sử dụng __TOC__Cú pháp. Xem mẫu .
• trên GitHub / repo : chuyển Markdown thành AsciiDoc . Sử dụng :toc:Cú pháp. Xem bản demo .

Tuy nhiên, bằng cách sử dụng các tệp Markdown trong GitHub / repo , bạn có thể tải nó trên các Trang GitHub như trong Wikipedia

• khi Jekyll được kích hoạt, nó tạo các Trang GitHub bằng Kramdown theo mặc định
• Kramdown đi kèm Table Of Content. Sử dụng {:toc}Cú pháp. Xem lời giải thích .

Mã Visual Studio

Nếu bạn tình cờ sử dụng Visual Studio Code , có một tiện ích mở rộng dễ sử dụng được gọi là Markdown All in One có thể tạo TOC cho bất kỳ tệp .md nào ngay lập tức.

Chỉ cần mở Command Palette ( Ctrl-Shift-P) ->Markdown: Create Table of Contents

Tự động cập nhật làm xáo trộn TOC đã chỉnh sửa của bạn?

Là một mẹo bổ sung, bạn có thể muốn TẮT "cập nhật TOC tự động khi lưu" bằng cách sử dụng

  "markdown.extension.toc.updateOnSave": false,

trong Cài đặt Visual Studio của bạn (Bảng lệnh -> Tùy chọn: Mở Cài đặt (JSON)).

Bạn có thể chọn chế độ Chỉnh sửa "MediaWiki", chế độ này sẽ tạo ra một tốc độ cho các tiêu đề, ví dụ:

== First ==

== Second ==

Do github có cách riêng để tạo thuộc tính id = ".." trong các tiêu đề h1, h2, h3, v.v. id = "slug") sẽ rất hữu ích nếu bạn không phát minh lại bánh xe và sử dụng thư viện đã thiết kế ngược quy trình này.

Tôi đã tìm thấy một thư viện khá tốt cho tác vụ này có tên là markdown-toc .

Đối với tôi, đó có vẻ là giải pháp tốt nhất vì tôi luôn cài đặt nút trên máy của mình.

Chỉ cần thực hiện npx markdown-toc -i file.md .

Và có vẻ như nó là một trong những công cụ phổ biến hơn cho tác vụ này - ít nhất là trong hệ sinh thái 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

đầu ra: