2013-08-15 44 views
27

Nếu bạn nhìn vào đây: http://en.wikipedia.org/wiki/Stack_OverflowLàm cách nào để tạo một số loại nội dung trong GitHub wiki?

Bạn sẽ nhận thấy có một phần "Nội dung", 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 thế nào để làm điều này trong GitHub wiki? Với Markdown hoặc bất cứ điều gì họ sử dụng?

+2

liên quan, nhưng không chính xác lặp lại, mà đi vào chi tiết hơn: http://stackoverflow.com/q/9721944/2291 –

Trả lời

37

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 đầu trang trong tệp GitHub Markdown, bạn sẽ thấy một liên kết đơn giản ở bên trái, 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>. Các <header name> phải được tất cả các trường hợp thấp hơn.

+7

Chắc chắn có một cách để autogenerate nó như của MediaWiki _ _ _ _ TOC? –

+4

@ LB--: Nếu bạn chỉnh sửa trang wiki GitHub và thay đổi danh sách thả xuống "kiểu chỉnh sửa" thành "MediaWiki", bạn có thể sử dụng trực tiếp MediaWiki '__TOC__'. Rõ ràng logic tự phát sinh cơ bản là ở đó. Nhưng chức năng dường như không bị lộ trong phong cách chỉnh sửa Markdown của họ. Khá đáng tiếc. Hãy bắt đầu gửi các yêu cầu tính năng cho nó và có thể họ sẽ bật nó lên. –

+2

Tôi recant trên "cơ bản autogeneration logic" đang có; có vẻ như các "kiểu chỉnh sửa" khác nhau đi qua các trình kết xuất khác nhau. Tuy nhiên, nó sẽ là tuyệt vời để có điều này trong phiên bản MD kể từ đó là khá phổ biến, và không thể khó để thêm. –

6

Một thể (bán tự động) Giải pháp là Eugene Kalinin của github-markdown-toc. Công cụ này chủ yếu là crunches thông qua tập tin README.md của bạn và snarfs ra các tiêu đề của # để tạo ra một TOC.

  1. Tải về kịch bản https://github.com/ekalinin/github-markdown-toc
  2. Thức ăn của bạn README.md để kịch bản (như đã nêu trong README.md Eugene)

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

  3. Cắt và dán TOC tạo ra và đặt nó ở phía trên cùng của README.md tập tin của bạn

Lưu ý rằng việc thực hiện bash này chỉ hoạt động trên Linux (từ những gì tôi có thể nói).

Như một mặt lưu ý, có một golang implementation và có lẽ là nhiều hơn một rắc rối để có được làm việc.

4

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

  • git clone your-repo.wiki.git (thêm .wiki ngay trước .git để clone wiki
  • npm i -g markdown-toc
  • Chèn <!-- toc --> (case sensitive) trong markdown của wiki của bạn
  • markdown-toc -i my-wiki-markdown.md (-i sẽ chỉnh sửa nó trong nơi)
  • Lợi nhuận
1

Hiện tại, not possible làm điều đó bằng cú pháp đánh dấu (.md). Hiện đang diễn ra không chính thức discussion about automatically generating table of contents TOC trên các tệp đánh dấu được hiển thị như README.md liệt kê một số ý tưởng.

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

1

Bạn có thể chọn các chế độ Edit "MediaWiki" mà sẽ tạo ra một toc cho các tiêu đề , ví dụ

== First == 

== Second == 
+0

Đúng. Xem https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki để biết ví dụ. – Agis

Các vấn đề liên quan