ToC atau Sidebar di GitHub Wiki

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:

• https://gist.github.com/379469 - beberapa peretasan JavaScript

• https://github.com/blog/774-git-powered-wikis-improved - GitHub menyebutkannya:

  "GitHub Wiki memiliki sedikit kemampuan terdokumentasi untuk footer dan sidebars, sesuatu yang familiar dengan beberapa penulis Wiki berbasis git kami. Editor Wiki baru memberi Anda pengeditan terbatas berbasis web dari footer dan sidebar yang Anda miliki di situs Anda. "

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.

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

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

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.

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?).

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

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

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):

• Rumah
• Instalasi
• Pemakaian
  • Mode masuk
  • Pengubah baris perintah
• Peta jalan

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.

GitHub akan membuat daftar isi dokumen secara otomatis:

1. Jadikan doc jenis AsciiDoc bukan Markdown.
2. Sisipkan :toc:di awal dokumen.