Bagaimana cara membuat semacam daftar isi di wiki GitHub?

Jika Anda melihat di sini: http://en.wikipedia.org/wiki/Stack_Overflow

Anda akan melihat ada sedikit bagian "Konten", jika Anda mengklik salah satu tautan, itu akan mengarahkan Anda ke bagian tertentu pada halaman.

Bagaimana saya melakukan ini di GitHub wiki? Dengan penurunan harga atau apa pun yang mereka gunakan?

Ini dengan baik ditunjukkan dalam Daftar Isi dari Cheatsheet Penurunan Harga .

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

Jika Anda mengarahkan kursor ke Header di file Penurunan Harga GitHub, Anda akan melihat tautan kecil di sebelah kiri, Anda juga dapat menggunakan tautan itu. Format tautan itu adalah <project URL#<header name>. Semua <header name>harus huruf kecil.

Satu solusi (semi-otomatis) yang mungkin adalah Eugene Kalinin github-markdown-toc. Alat ini pada dasarnya README.mdmengolah file Anda dan mencari #judul untuk membuat TOC.

1. Unduh skrip https://github.com/ekalinin/github-markdown-toc

2. Beri makan Anda README.mdke skrip (seperti yang dicatat dalam Eugene README.md)

   cat README.md | bash github-markdown-toc

3. Potong dan tempel TOC yang dihasilkan dan letakkan di bagian atas README.mdfile Anda

Perhatikan bahwa bashimplementasi ini hanya berfungsi di Linux (dari apa yang saya tahu).

Sebagai catatan tambahan, ada implementasi golang dan mungkin lebih merepotkan untuk mulai bekerja.

Karena github tidak dapat digunakan TOC secara langsung, tetapi kami memiliki alternatif lain.

Anda dapat membuat TOC secara otomatis melalui alat Online:

Buat Daftar Isi Daftar Isi dari Penurunan Harga GitHub atau Wiki Online

atau melalui alat Lokal:

github-markdown-toc

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

• git clone your-repo.wiki.git(tambahkan .wikihak sebelumnya .gituntuk mengkloning wiki
• npm i -g markdown-toc
• Sisipkan <!-- toc -->(peka huruf besar-kecil) di penurunan harga wiki Anda
• markdown-toc -i my-wiki-markdown.md( -iakan mengeditnya di tempat)
• Keuntungan

Pembaruan: Saya pikir mungkin https://github.com/thlorenz/doctoc lebih populer sekarang.

Saat ini tidak mungkin melakukannya menggunakan sintaks penurunan harga ( .md). Ada diskusi tidak resmi yang sedang berlangsung tentang secara otomatis membuat daftar isi TOC pada file penurunan harga yang diberikan seperti README.mdyang mencantumkan beberapa ide.

Namun ada beberapa solusi lain seperti:

• Gunakan AsciiDocsebagai gantinya sesuai saran dari komentar ini . Sebagai contoh:

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

  Periksa contoh di littlebits/react-popover( README.adoc) .

• Pembuat Daftar Isi Online ( raychenon / play-table-of-content )

• arthurhammer / github-toc - ekstensi browser yang menambahkan daftar isi ke repo GitHub

Jika Anda tidak dalam posisi untuk tetap dengan penurunan harga , Anda dapat melakukan seperti di bawah ini:

• di GitHub / wiki : alihkan Penurunan harga ke MediaWiki . Gunakan __TOC__Sintaks. Lihat contoh .
• di GitHub / repo : alihkan Markdown ke AsciiDoc . Gunakan :toc:Sintaks. Lihat demo .

Namun, dengan menggunakan file Markdown di GitHub / repo , Anda bisa mendapatkannya di Halaman GitHub seperti di Wikipedia

• ketika Jekyll diaktifkan, itu menghasilkan Halaman GitHub menggunakan Kramdown secara default
• Kramdown datang dengan Table Of Content. Gunakan {:toc}Sintaks. Simak penjelasannya .

Kode Visual Studio

Jika Anda kebetulan menggunakan Visual Studio Code , ada ekstensi yang mudah digunakan yang disebut Markdown All in One yang dapat membuat TOC untuk file .md apa pun dalam sekejap.

Cukup buka Command Palette ( Ctrl-Shift-P) ->Markdown: Create Table of Contents

Pembaruan otomatis mengacaukan Daftar Isi yang Anda edit?

Sebagai tip tambahan, Anda mungkin ingin MENONAKTIFKAN "pembaruan TOC otomatis saat menyimpan" dengan menggunakan

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

di Visual Studio Settings (Command Palette -> Preferences: Open Settings (JSON)).

Anda dapat memilih mode Edit "MediaWiki" yang akan menghasilkan toc untuk header, mis

== First ==

== Second ==

Karena fakta bahwa github memiliki caranya sendiri untuk menghasilkan atribut id = ".." di h1, h2, h3, dll ... header dalam versi html setelah memproses Penurunan harga (misalnya Bitbucket menggunakan pola yang sedikit berbeda dari judul judul yang lambat untuk id = "slug") berguna untuk tidak menemukan kembali roda dan menggunakan pustaka yang merekayasa balik proses ini.

Saya menemukan satu perpustakaan yang cukup bagus untuk tugas ini yang disebut markdown-toc .

Bagi saya ini sepertinya solusi terbaik karena saya selalu menginstal node di mesin saya.

Hanya menjalankan npx penurunan harga-toc -i file.md .

Dan sepertinya ini adalah salah satu alat yang lebih populer untuk tugas ini - setidaknya di ekosistem node.js.

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

keluaran: