ToC hoặc Thanh bên trong GitHub Wiki

87

Làm cách nào để tạo ToC hoặc menu thanh bên trong Wiki GitHub?

Tôi đã thấy một số đề cập về nó và gollum phần phụ trợ dường như hỗ trợ nó, nhưng làm cách nào để làm điều đó trong một dự án GitHub hiện tại?

Tốt nhất nên dựa trên các tiêu đề tôi có trong trang một cách tự động.

Tất cả các liên kết này đều đề cập đến nó, nhưng không chỉ ra cách thực hiện:

  • https://gist.github.com/379469 - một số bản hack JavaScript

  • https://github.com/blog/774-git-powered-wikis-improved - GitHub đề cập đến nó:

    "GitHub Wiki có một khả năng ít tài liệu cho chân trang và thanh bên, điều mà một số tác giả Wiki dựa trên git của chúng tôi quen thuộc. Trình chỉnh sửa Wiki mới cung cấp cho bạn khả năng chỉnh sửa dựa trên web giới hạn đối với chân trang và thanh bên mà bạn có trên trang web của mình. "

github  wiki 
— con chó
nguồn
3
Tôi đã phát triển GitHub Wikifier: Một Git Hook cam kết trước sẽ tạo ra tất cả Mục lục mà bạn cần. Chỉ cần viết nội dung của bạn và để nó tiếp quản. Có thể đáng để kiểm tra. github.com/kuroir/GitHub-Wikifier
— MarioRicalde 29/12/12
— Ciro Santilli 郝海东 冠状 病 六四 事件 法轮功
Mã của @MarioRicalde được chuyển đến github.com/hybridgroup/GitHub-Wikifier
— Jonny

Câu trả lời:

76

Trong khi giải pháp của bạn hoạt động, có một cách dễ dàng hơn để thực hiện điều đó bằng giao diện web của GitHub. Bạn chỉ cần tạo một trang có tên _Sidebarvà / hoặc _Footer.

Xem hướng dẫn chi tiết trong trình tạo menu thanh bên của Github Wiki với nhiều cấp .

Chỉnh sửa Bài viết gốc đã biến mất và tôi không thể tìm thấy nó trong bộ nhớ cache nên tôi đã cập nhật liên kết.

— Nicerobot
nguồn
7
@CodeSherpa họ có thể truy cập vào https://github.com/[user]/[repo]/wiki/_Sidebar/_editvàhttps://github.com/[user]/[repo]/wiki/_Footer/_edit
— nicerobot
1
Bài viết rất hay nhưng cung cấp thông tin không chính xác (hoặc lỗi thời) về cách lấy URL của wiki. Trong trường hợp bạn bị lạc như tôi, bạn phải sử dụng URL https://github.com/<username>/<projectname>.wiki.githoặc SSH git@github.com:<username>/<projectname>.wiki.git.
— NightOwl888
1
Những hướng dẫn chi tiết này khá nghèo nàn. A là [[link]]gì? Đặt một URL vào đó dẫn đến toàn bộ URL hiển thị.
— Pithikos
3
@Pithikos đó là Github Markdown phát biểu. Các hướng dẫn không có để dạy bạn Markdown. Họ ở đó để giải thích thanh bên.
— nicerobot
2
@nicerobot và cách tốt nhất để giải thích một cái gì đó là bằng cách sử dụng một ví dụ cụ thể ..
— Pithikos
26

Khi bạn ở trong wiki của dự án, có một liên kết Thêm thanh bên tùy chỉnh . Nhấp vào đó.

Nhập mô tả hình ảnh tại đây

Bây giờ bạn có một trang mà bạn chỉnh sửa như bạn sẽ chỉnh sửa bất kỳ trang Markdown nào khác . Tuy nhiên, để tạo mục lục, bạn phải thực hiện theo cách thủ công. Không có phương pháp tự động (kể từ tháng 8 năm 2014). Ví dụ:

# 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
— Pithikos
nguồn
25

Được chứ. Hãy để tôi xem liệu tôi có hiểu đúng điều này không:

  1. Sao chép wiki GitHub của bạn. (Có một phần Git trong wiki. Bạn có thể kiểm tra mã giống wiki của mình.)
  2. Tạo nên _Sidebar.md
  3. Trong các trang wiki thông thường, hãy sử dụng [[link]]cho thanh bên
  4. Cam kết và đẩy trở lại GitHub

Quá trình này là một nỗi đau trong ass. Tôi ngạc nhiên vì wiki “gollum” này lại được chấp nhận.

Ngoài ra: _Sidebar.md do đó là toàn cầu cho tất cả các trang . Tôi sẽ phải sắp xếp wiki của mình thành các thư mục, vì vậy tôi có thể xác định các thanh bên khác nhau cho các trang khác nhau.

— con chó
nguồn
2
Theo tài liệu, bạn có thể thêm các thanh bên khác nhau cho các thư mục khác nhau: "Thanh bên ảnh hưởng đến tất cả các trang trong thư mục của chúng và bất kỳ thư mục con nào không có tệp thanh bên của riêng chúng." xem: github.com/github/gollum
— Subfuzion
10

Lưu ý rằng câu hỏi ban đầu là về việc tạo một thanh bên (dễ dàng, được giải quyết trong các câu trả lời) hoặc một mục lục thực tế (không được trả lời).

Tôi có thể nói một điều là cú pháp wiki gollum 2.1 cho phép một [[_TOC_]]thẻ, nhưng wiki GitHub sẽ không nhận ra điều đó (chưa?).

— dấu
nguồn
4
Bạn đã gặp may mắn chưa? Điều này khiến Trác vô cùng bực bội khi tất cả những việc này đều được thực hiện một cách dễ dàng.
— jooks 30/1213
Tôi nghĩ rằng câu trả lời tốt hơn cho câu hỏi ban đầu về cách tạo mục lục "dựa trên các tiêu đề mà tôi có trong trang một cách tự động" hiện là điều không thể với GitHub Wiki.
— avernet
Đây hiện đang là vấn đề bỏ ngỏ (lười tra số quá) mà hàng trăm người đã bình luận. Chưa có thông tin phản hồi nào từ GitHub :(
— abalter 14/03/16
Những vấn đề GitHub chính mà tham khảo này là của 2017/01/19 bao gồm: 1. Markdown - Table of Contents 2. Chèn bảng tự động tạo ra các nội dung TOC trên các tập tin markdown render như README.md
— ckib16
4

Tôi nghĩ điều này được mô tả trong GollumREADME . (Xem phần tiêu đề và thanh bên.)

Về cơ bản, bạn tạo một _footer.extvà _sidebar.exttrong thư mục chứa nội dung trang.

— seandavi
nguồn
2

Tôi đã triển khai mô-đun npm github-wiki-sidebar để giúp người dùng github dễ dàng tạo và duy trì menu sidebar.

Nguồn và Kết quả: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Các trang nguồn (như được hiển thị trong quản trị Wiki):

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

Kết quả (với thứ tự tùy chỉnh):

Yêu cầu trước:

  • sao chép cục bộ kho lưu trữ wiki github của bạn (hiển thị ở phía dưới bên phải của giao diện người dùng Wiki)

  • cài đặt github-wiki-sidebar

    git clone <https://github.com/<username>/<my-project-name>.wiki.git
npm install -g github-wiki-sidebar

Tạo / cập nhật menu wiki của bạn:

  • tạo trang mới / đổi tên trang trên quản trị viên wiki github.com của bạn

  • thực thi cục bộ tập lệnh github-wiki-sidebar trong thư mục kho lưu trữ wiki của bạn

    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

Mô-đun cho phép tùy chỉnh đầu ra đánh dấu bao gồm thứ tự các mục, dấu phân tách danh mục, mẫu cho menu, định dạng liên kết và những thứ khác.

— adtanasa
nguồn
0

GitHub sẽ tự động tạo mục lục tài liệu:

  1. Đặt loại tài liệu là AsciiDoc thay vì Markdown.
  2. Chèn :toc:vào đầu tài liệu.
— Dogweather
nguồn
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookie và Chính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.