ToC atau Sidebar di GitHub Wiki

88

Bagaimana cara membuat ToC atau menu sidebar di GitHub Wiki?

Saya melihat beberapa penyebutan dan gollum tampaknya mendukung backend, tetapi bagaimana cara melakukannya dalam proyek GitHub saat ini?

Sebaiknya berdasarkan header yang saya miliki di halaman secara otomatis.

Semua tautan ini menyebutkannya, tetapi tidak menunjukkan cara melakukannya:

github  wiki 
— wolle
sumber
3
Saya mengembangkan GitHub Wikifier: Git Hook pra-komit yang akan menghasilkan semua Daftar Isi yang Anda perlukan. Tulis saja konten Anda, dan biarkan mengambil alih. Mungkin layak untuk dicek. github.com/kuroir/GitHub-Wikifier
— MarioRicalde
— Ciro Santilli 郝海东 冠状 病 六四 事件 法轮功
— Jonny

Jawaban:

76

Sementara solusi Anda berfungsi, ada cara yang lebih mudah untuk melakukannya menggunakan antarmuka web GitHub. Anda cukup membuat halaman bernama _Sidebardan / atau _Footer.

Lihat petunjuk rinci di pembuat menu bilah samping Github Wiki dengan multi-level .

Sunting Artikel asli hilang dan saya tidak dapat menemukannya di cache, jadi saya telah memperbarui tautannya.

— nicerobot
sumber
7
@CodeSherpa mereka dapat diakses di https://github.com/[user]/[repo]/wiki/_Sidebar/_editdanhttps://github.com/[user]/[repo]/wiki/_Footer/_edit
— nicerobot
1
Artikelnya bagus tetapi memberikan informasi yang salah (atau ketinggalan zaman) tentang cara mendapatkan URL wiki. Jika Anda tersesat seperti saya, Anda harus menggunakan URL https://github.com/<username>/<projectname>.wiki.gitatau SSH git@github.com:<username>/<projectname>.wiki.git.
— NightOwl888
1
Ini petunjuk rinci cukup miskin. Apa itu [[link]]? Menempatkan URL di sana menghasilkan seluruh URL yang muncul.
— Pithikos
3
@Pithikos itu Github Markdown berbicara. Instruksi tidak ada untuk mengajari Anda penurunan harga. Mereka ada di sana untuk menjelaskan sidebar.
— nicerobot
2
@nicerobot dan cara terbaik untuk menjelaskan sesuatu adalah dengan menggunakan contoh konkret ..
— Pithikos
26

Saat Anda berada di wiki proyek Anda, ada tautan Tambahkan bilah sisi khusus . Klik itu.

Masukkan deskripsi gambar di sini

Sekarang Anda memiliki halaman yang Anda edit seperti Anda mengedit halaman penurunan harga lainnya . Untuk membuat daftar isi Anda harus melakukannya secara manual. Tidak ada metode otomatis (per Agustus 2014). Jadi contohnya:

# 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
sumber
25

Baik. Biarkan saya melihat apakah saya memahami ini dengan benar:

  1. Kloning wiki GitHub Anda. (Ada bagian Git di wiki. Anda dapat memeriksa kode serupa wiki Anda.)
  2. Membuat _Sidebar.md
  3. Di halaman wiki biasa, gunakan [[link]]untuk sidebar
  4. Berkomitmen dan dorong kembali ke GitHub

Proses ini menyebalkan. Saya terkejut wiki "gollum" ini diterima.

Juga: _Sidebar.md karena itu bersifat global untuk semua halaman . Saya harus mengatur wiki saya ke dalam folder, jadi saya dapat menentukan bilah sisi yang berbeda untuk halaman yang berbeda.

— wolle
sumber
2
Menurut dokumen tersebut, Anda dapat menambahkan sidebar yang berbeda untuk folder yang berbeda: "Sidebars mempengaruhi semua halaman dalam direktorinya dan setiap subdirektori yang tidak memiliki file sidebar sendiri." lihat: github.com/github/gollum
— Subfuzion
10

Perhatikan bahwa pertanyaan awal adalah tentang membuat bilah samping (mudah, diselesaikan dalam jawaban) atau daftar isi yang sebenarnya (tidak dijawab).

Satu hal yang dapat saya katakan adalah bahwa sintaks wiki gollum 2.1 memungkinkan untuk sebuah [[_TOC_]]tag, tetapi wiki GitHub tidak akan mengenalinya (belum?).

— menandai
sumber
4
Apakah Anda beruntung? Ini sangat membuat frustrasi datang dari Trac di mana semua hal ini dapat dilakukan dengan mudah.
— lelucon
Saya rasa jawaban yang lebih baik untuk pertanyaan awal tentang bagaimana membuat daftar isi "berdasarkan tajuk yang saya miliki di halaman secara otomatis" adalah yang saat ini tidak mungkin dilakukan dengan GitHub Wiki.
— avernet
Saat ini masalah terbuka (terlalu malas untuk mencari nomornya) yang dikomentari oleh ratusan orang. Belum ada kabar dari GitHub :(
— abalter
— ckib16
4

Saya pikir ini dijelaskan di GollumREADME . (Lihat bagian header dan sidebar.)

Intinya, Anda membuat _footer.extdan _sidebar.extdi direktori yang berisi konten halaman.

— seandavi
sumber
2

Saya telah menerapkan modul npm github-wiki-sidebar untuk membantu pengguna github dengan mudah membuat dan memelihara menu sidebar.

Sumber dan Hasil: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Halaman sumber (seperti yang ditampilkan di admin Wiki):

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

Hasil (dengan pesanan khusus):

Prasyarat:

  • kloning repositori wiki github Anda secara lokal (ditampilkan di kanan bawah UI Wiki)

  • instal github-wiki-sidebar

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

Buat / perbarui menu wiki Anda:

  • buat halaman baru / ganti nama halaman di admin wiki github.com Anda

  • jalankan secara lokal skrip github-wiki-sidebar di folder repositori wiki Anda

    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

Modul ini memungkinkan penyesuaian output penurunan harga termasuk pemesanan item, pemisah kategori, templat untuk menu, format tautan, dan lainnya.

— adtanasa
sumber
0

GitHub akan membuat daftar isi dokumen secara otomatis:

  1. Jadikan doc jenis AsciiDoc bukan Markdown.
  2. Sisipkan :toc:di awal dokumen.
— Dogweather
sumber
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.