GitHub wiki'de nasıl bir tür içerik tablosu oluşturabilirim?

Buraya bakarsanız: http://en.wikipedia.org/wiki/Stack_Overflow

Küçük bir "İçerik" bölümü olduğunu fark edeceksiniz, bağlantılardan birine tıklarsanız, sizi sayfada belirli bir bölüme gönderecektir.

Bunu GitHub wiki'de nasıl yaparım? Markdown ile mi yoksa kullandıkları her ne ise?

Markdown Cheatsheet'in İçindekiler Tablosunda güzel bir şekilde gösterilmiştir .

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

Bir GitHub Markdown dosyasında bir Başlığın üzerine gelirseniz, solunda basit bir bağlantı görürsünüz, bu bağlantıyı da kullanabilirsiniz. Bu bağlantının biçimi <project URL#<header name>. <header name>Bütün küçük harf olmalıdır.

Olası (yarı otomatik) çözümlerden biri Eugene Kalinin'tir github-markdown-toc. Bu araç, esasen README.mddosyanızda ilerleyerek #bir İçindekiler Tablosu oluşturmak için başlıklarını tarar .

1. Komut dosyasını indirin https://github.com/ekalinin/github-markdown-toc

2. Kendinizi README.mdsenaryoya verin (Eugene'de belirtildiği gibi README.md)

   kedi README.md | bash github-markdown-toc

3. Oluşturulan TOC'yi kesip yapıştırın ve README.mddosyanızın en üstüne yerleştirin

Bu bashuygulamanın yalnızca Linux üzerinde çalıştığını unutmayın (anlayabildiğim kadarıyla).

Bir yan not olarak, bir golang uygulaması var ve muhtemelen çalışmaya başlamak için daha zor .

Github TOCdoğrudan kullanamadığı için , ancak başka alternatiflerimiz var.

Çevrimiçi araç aracılığıyla otomatik olarak TOC oluşturabilirsiniz :

GitHub Markdown veya Wiki Online'dan TOC İçindekiler Tablosu oluşturun

veya Yerel araç aracılığıyla :

github-markdown-toc

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

• git clone your-repo.wiki.git( wiki'yi klonlamak için .wikisağa ekleyin.git
• npm i -g markdown-toc
• Takın <!-- toc -->sizin Wiki'nin markdown içinde (küçük harf duyarlı)
• markdown-toc -i my-wiki-markdown.md( -iyerinde düzenleyecek)
• Kar

Güncelleme: Sanırım https://github.com/thlorenz/doctoc artık daha popüler.

Şu anda bunu markdown sözdizimi ( ) kullanarak yapmak mümkün değildir.md . Bazı fikirlerin listelendiği gibi işlenmiş markdown dosyalarında TOC'nin otomatik olarak üretilmesi hakkında süregelen resmi olmayan tartışmalar varREADME.md .

Ancak, aşağıdakiler gibi başka geçici çözümler de vardır:

• AsciiDocBunun yerine bu yorumun önerisine göre kullanın . Örneğin:

  :toc: macro
  :toc-title:
  :toclevels: 99
  # Title
  
  toc::[]
  
  ## A
  
  ### A2
  
  ## B
  
  ### B2
  

  littlebits/react-popover( README.adoc) ' Deki örneği kontrol edin .

• Çevrimiçi İçerik Oluşturucu Tablosu ( raychenon / play-table-of-içindekiler )

• arthurhammer / github-toc - GitHub depolarına içindekiler tablosu ekleyen tarayıcı uzantısı

Markdown'a bağlı kalacak konumda değilseniz, aşağıdaki işlemleri yapabilirsiniz:

• üzerinde GitHub / wiki : geçiş Markdown için MediaWiki . __TOC__Sözdizimi kullanın . Bkz örnek .
• üzerinde GitHub / repo : geçiş Markdown için AsciiDoc . :toc:Sözdizimi kullanın . Bkz demo .

Ancak, GitHub / repo'daki Markdown dosyalarını kullanarak , Wikipedia'daki gibi GitHub Sayfalarında edinebilirsiniz.

• zaman Jekyll etkinleştirildiğinde, aynı zamanda yarattığı GitHub Sayfaları kullanarak Kramdown varsayılan olarak
• Kramdown ile birlikte gelir Table Of Content. {:toc}Sözdizimi kullanın . Açıklamaya bakın .

Visual Studio Kodu

Kullanmak edersek Visual Studio Kodu , kolay kullanımlı denilen uzatma yoktur One Markdown tüm anında herhangi .md dosya için TOC yapabilirsiniz.

Komut Paletini ( Ctrl-Shift-P) açın ->Markdown: Create Table of Contents

Otomatik güncelleme, düzenlediğiniz TOC'nizi karıştırır mı?

Ek bir ipucu olarak, "kaydederken otomatik TOC güncellemelerini" KAPATMAK isteyebilirsiniz:

  "markdown.extension.toc.updateOnSave": false,

Visual Studio Ayarlarınızda (Komut Paleti -> Tercihler: Ayarları Aç (JSON)).

Başlıklar için bir toc oluşturacak "MediaWiki" Düzenleme modunu seçebilirsiniz, örn.

== First ==

== Second ==

Github'ın h1, h2, h3, vb. İçin id = ".." öznitelikleri oluşturmanın kendine özgü bir yolu olması nedeniyle ... id = "slug") tekerleği yeniden icat etmemek ve bu işlemi tersine mühendislik uygulayan kitaplığı kullanmak kullanışlıdır.

Bu görev için markdown-toc adında oldukça iyi bir kitaplık buldum .

Benim için en iyi çözüm gibi görünüyor çünkü makineme her zaman düğüm kurdum.

Sadece npx markdown-toc -i file.md'yi çalıştırın .

Ve bu görev için daha popüler araçlardan biri gibi görünüyor - en azından node.js ekosisteminde.

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

çıktı: