GitHub Wiki'de ToC veya Kenar Çubuğu

GitHub Wiki'de nasıl bir ToC veya kenar çubuğu menüsü oluşturabilirim?

Bazı sözler gördüm ve gollum arka uç onu destekliyor gibi görünüyor, ancak mevcut GitHub projesinde bunu nasıl yapabilirim?

Sayfada otomatik olarak sahip olduğum başlıkları temel alması en iyisidir.

Bu bağlantıların tümü bundan bahsediyor, ancak nasıl yapılacağını göstermiyor:

• https://gist.github.com/379469 - JavaScript saldırısı

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

  "GitHub Wiki'lerin altbilgiler ve kenar çubukları için çok az belgelenmiş bir yeteneği var, bu, git tabanlı Wiki yazarlarımızdan bazılarının aşina olduğu bir şey. Yeni Wiki editörü, sitenizdeki altbilgiler ve kenar çubuklarının sınırlı web tabanlı düzenlenmesini sağlıyor. "

Çözümünüz çalışırken, GitHub'ın web arayüzünü kullanarak bunu yapmanın daha kolay bir yolu var. Basitçe _Sidebarve / veya adında bir sayfa oluşturabilirsiniz _Footer.

Çok düzeyli Github Wiki kenar çubuğu menü oluşturucusundaki ayrıntılı talimatlara bakın .

Düzenle Orijinal makale gitti ve önbellekte bulamadığım için bağlantıyı güncelledim.

Projenizin wiki'sindeyken, bir Özel kenar çubuğu ekle bağlantısı vardır . Bunu tıklayın.

Artık diğer Markdown sayfalarını düzenler gibi düzenlediğiniz bir sayfanız var. İçindekiler tablosu yapmak için bunu elle yapmanız gerekir. Otomatikleştirilmiş bir yöntem yoktur (Ağustos 2014 itibariyle). Yani mesela:

# 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

Tamam. Bunu doğru anlayıp anlamadığıma bir bakalım:

1. GitHub wiki'nizi klonlayın. (Wiki'de bir Git bölümü var. Wiki benzeri kodunuzu kontrol edebilirsiniz.)
2. Oluşturmak _Sidebar.md
3. Normal wiki sayfalarında [[link]]kenar çubuğu için kullanın
4. Kaydet ve GitHub'a geri gönder

Bu süreç baş belasıdır. Bu "gollum" wiki'nin kabul görmesine şaşırdım.

Ayrıca: _Sidebar.md bu nedenle tüm sayfalar için geneldir . Wiki'mi klasörler halinde düzenlemem gerekir, böylece farklı sayfalar için farklı kenar çubukları tanımlayabilirim.

Asıl sorunun bir yan çubuk (kolay, cevaplarda çözülmüş) veya gerçek bir içindekiler tablosu (cevaplanmamış) oluşturmakla ilgili olduğunu unutmayın.

Söyleyebileceğim tek şey, gollum 2.1 wiki sözdiziminin bir [[_TOC_]]etikete izin verdiğidir , ancak bir GitHub wiki bunu (henüz?)

Sanırım bu Gollum'daREADME anlatılıyor . (Başlık ve kenar çubuğu bölümlerine bakın.)

Esasen, sayfa içeriğini içeren dizinde bir _footer.extve yaparsınız _sidebar.ext.

Npm modülünü github-wiki-sidebar uyguladım kullanıcılarının kenar çubuğu menüsünü kolayca oluşturmasına ve sürdürmesine yardımcı olmak .

Kaynak ve Sonuç: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Kaynak sayfalar (Wiki yöneticisinde gösterildiği gibi):

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

Sonuç (özelleştirilmiş siparişle):

• Ev
• Kurulum
• Kullanım
  • Başlatma modu
  • Komut satırı değiştiricileri
• Yol haritası

Ön Gereksinimler:

• github wiki deponuzu yerel olarak klonlayın (Wiki kullanıcı arayüzünün sağ alt kısmında görüntülenir)

• github-wiki-kenar çubuğunu kurun

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

Wiki menünüzü oluşturun / güncelleyin:

• github.com wiki yöneticinizde yeni sayfalar oluşturun / sayfaları yeniden adlandırın

• wiki deposu klasörünüzdeki github-wiki-sidebar komut dosyasını yerel olarak çalıştırı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
  

Modül, öğelerin sıralanması, kategori ayırıcı, menü şablonu, bağlantıların biçimi ve diğerleri dahil olmak üzere indirgeme çıktısının özelleştirilmesine izin verir.

GitHub otomatik olarak bir belge içindekiler tablosu oluşturacaktır:

1. Markdown yerine belge türü AsciiDoc yapın.
2. :toc:Belgenin başına ekleyin .