Saya mulai menggunakan penurunan harga untuk membuat catatan.
Saya menggunakan yang ditandai untuk melihat catatan penurunan harga saya dan itu indah.
Tetapi karena catatan saya semakin panjang, saya merasa sulit untuk menemukan apa yang saya inginkan.
Saya tahu penurunan harga dapat membuat tabel, tetapi apakah ini dapat membuat daftar isi, yang melompat ke bagian, atau menentukan bagian halaman dalam penurunan harga?
Atau, apakah ada pembaca / editor yang dapat melakukan hal-hal seperti itu. Pencarian juga akan menjadi fitur yang bagus.
Singkatnya, saya ingin menjadikannya alat pencatat yang luar biasa dan fungsinya seperti menulis buku, dll.
\tableofcontents
. Jika roda akan diciptakan kembali, akan lebih baik untuk menyalin bagian yang baik... contents::
.Jawaban:
MultiMarkdown Composer tampaknya menghasilkan daftar isi untuk membantu saat mengedit.
Mungkin juga ada satu atau perpustakaan lain, yang dapat menghasilkan TOCs: lihat Python Markdown TOC Extension .
sumber
Anda bisa mencobanya.
sumber
## Example ## "Example2" ## Third Example<a name="third-example" />
adalah satu-satunya cara saya bisa menelan ruang sejauh ini. Tentunya tag ke-3 akan ditafsirkan sebagai -#Third
- diikuti oleh spasi - lalu kata Contoh - dalam cuplikan Anda di atas? Tanda hubung tidak bekerja sama sekali. Terima kasih1. [Einführung](#einfuhrung)
Inilah metode yang bermanfaat. Harus menghasilkan referensi yang dapat diklik di editor MarkDown apa pun.
Menghasilkan:
Daftar Isi
Inilah pengantar
Beberapa teks pengantar, diformat dalam judul 2 gaya
Beberapa paragraf
Teks paragraf pertama
Sub paragraf
Ini adalah sub paragraf, diformat dalam judul 3 gaya
Paragraf lain
Teks paragraf kedua
sumber
## <a name="foo" /> Foo
Untuk pengguna Visual Studio Code , ide yang bagus adalah menggunakan Markdown TOC plugin .
Untuk menginstalnya, luncurkan VS Code Quick Open ( Control/⌘+ P), rekatkan perintah berikut, dan tekan enter.
Dan untuk menghasilkan TOC, buka palet perintah ( Control/⌘+ Shift+ P) dan pilih
Markdown TOC:Insert/Update option
atau gunakan Control/⌘+ MT.sumber
[Section Foo](#foo-header-title)
dan bahkan berfungsi di luar mode pratinjau (yaitu dalam penurunan harga biasa).Anda dapat mencoba skrip ruby ini untuk menghasilkan TOC dari file penurunan harga.
sumber
ifndef
,include
danendif
, antara arahan preprocessor lain, untuk daftar kata-kata terlarang. Juga, mendefinisikan daftar di luar lingkup loop menghindari harus menginstalnya kembali dengan setiap iterasi. Juga, ini akan mengambil komentar dari bahasa apa pun yang menggunakan#
sintaksis komentar, termasuk Ruby, yang tidak baik. Saya bersedia mengedit jika Anda mau. Namun ini adalah awal yang baik dan bekerja dengan baik untuk tujuan saya. Terima kasih banyak!#
), bukan dengan yang setext (bergaris bawah).title.parameterize
untuk href, terima kasih!Ada 2 cara untuk membuat TOC Anda (ringkasan) dalam dokumen penurunan harga Anda.
1. Secara manual
2. Secara pemrograman
Misalnya, Anda dapat menggunakan skrip yang menghasilkan ringkasan untuk Anda, lihat proyek saya di github - summarizeMD -
Saya sudah mencoba juga modul script / npm lainnya (misalnya doctoc ) tetapi tidak ada yang mereproduksi TOC dengan anchor yang berfungsi.
sumber
Jika Anda menggunakan tambahan penurunan harga, jangan lupa Anda dapat menambahkan atribut khusus ke tautan, header, pagar kode, dan gambar.
https://michelf.ca/projects/php-markdown/extra/#spe-attr
sumber
Anchor tag yang dihasilkan oleh parser penurunan harga yang berbeda bahkan tidak.
Jika Anda bekerja dengan parser Markdown GFM (GitHub Flavoured Markdown) atau Redcarpet, saya menulis plugin Vim untuk menangani daftar isi.
fitur
Hasilkan daftar isi untuk file Markdown.
Parser Markdown yang didukung:
Perbarui daftar isi yang ada.
Perbarui otomatis daftar isi yang ada di save.
Tangkapan layar
Pemakaian
Hasilkan daftar isi
Pindahkan kursor ke baris yang ingin Anda tambahkan daftar isi, lalu ketikkan perintah di bawah yang sesuai untuk Anda. Perintah akan menghasilkan heading setelah kursor masuk ke daftar isi.
:GenTocGFM
Buat daftar isi dengan gaya tautan GFM.
Perintah ini cocok untuk file Markdown di repositori GitHub, seperti README.md, dan file Markdown untuk GitBook.
:GenTocRedcarpet
Buat daftar isi dengan gaya tautan Redcarpet.
Perintah ini cocok untuk Jekyll atau di mana pun menggunakan Redcarpet sebagai pengurai Markdown-nya.
Anda dapat melihat di sini untuk mengetahui perbedaan antara tautan toc gaya GFM dan Redcarpet.
Perbarui daftar isi yang ada secara manual
Secara umum Anda tidak perlu melakukan ini, daftar isi yang ada akan secara otomatis diperbarui saat penyimpanan secara default. Jika Anda ingin melakukannya secara manual, gunakan saja
:UpdateToc
perintah.Unduhan dan dokumen
https://github.com/mzlogin/vim-markdown-toc
sumber
Anda juga dapat menggunakan
pandoc
, "swiss-army knife" untuk mengubah "satu format markup menjadi yang lain" . Secara otomatis dapat menghasilkan daftar isi dalam dokumen keluaran jika Anda menyediakan--toc
argumen.Petunjuk: Jika Anda ingin daftar isi dalam
html
output, Anda juga perlu menyediakan-s
yang menghasilkan dokumen mandiri.Baris perintah shell contoh:
sumber
Untuk kepentingan kita yang membuat
README.md
file di Atom (bagaimana saya menemukan utas ini):https://atom.io/packages/markdown-toc
sumber
Jika Anda ingin menggunakan alat javascript / node.js, lihat markdown-toc .
sumber
Anda bisa membuatnya menggunakan bash one-liner ini. Mengasumsikan file penurunan harga Anda dipanggil
FILE.md
.sumber
Saya baru saja mengkodekan ekstensi
python-markdown
, yang menggunakan parsernya untuk mengambil judul, dan menampilkan TOC sebagai daftar tidak berurutan yang diformat dengan Markdown dengan tautan lokal. File tersebut adalahmd_toc.py)... dan itu harus ditempatkan di
markdown/extensions/
direktori dalam instalasi penurunan harga. Kemudian, yang harus Anda lakukan adalah mengetikkan jangkar<a>
tag denganid="..."
atribut sebagai referensi - jadi untuk teks input seperti ini:... ekstensi bisa disebut seperti ini:
... dan kemudian Anda dapat menempelkan kembali toc ini dalam dokumen penurunan harga Anda (atau memiliki pintasan di editor teks Anda, yang memanggil skrip pada dokumen yang saat ini terbuka, dan kemudian memasukkan TOC yang dihasilkan dalam dokumen yang sama).
Perhatikan bahwa versi yang lebih lama dari
python-markdown
tidak memiliki__main__.py
modul, dan dengan demikian, panggilan baris perintah seperti di atas tidak akan berfungsi untuk versi tersebut.sumber
Seperti disebutkan dalam jawaban lain, ada beberapa cara untuk menghasilkan daftar isi secara otomatis. Sebagian besar adalah perangkat lunak open source dan dapat disesuaikan dengan kebutuhan Anda.
Apa yang saya lewatkan adalah, bagaimanapun, format visual yang menarik untuk daftar isi, menggunakan opsi terbatas yang disediakan Markdown. Kami datang dengan yang berikut:
Kode
Di dalam dokumen Anda, Anda akan menempatkan penanda sub bagian target seperti ini:
Bergantung pada di mana dan bagaimana Anda menggunakan penurunan harga, yang berikut ini juga harus berfungsi, dan memberikan kode penurunan harga yang lebih bagus:
Contoh rendering
Keuntungan
Anda dapat menambahkan level bab dan sub-bab sebanyak yang Anda butuhkan. Dalam Daftar Isi, ini akan muncul sebagai daftar unordered bersarang di tingkat yang lebih dalam.
Tidak menggunakan daftar yang dipesan. Ini akan membuat lekukan, tidak akan menautkan nomor, dan tidak dapat digunakan untuk membuat penomoran klasifikasi desimal seperti "1.1."
Tidak ada penggunaan daftar untuk level pertama. Di sini, menggunakan daftar yang tidak berurutan dimungkinkan, tetapi tidak perlu: lekukan dan peluru hanya menambah kekacauan visual dan tidak ada fungsi di sini, jadi kami tidak menggunakan daftar untuk level ToC pertama sama sekali.
Penekanan visual pada bagian tingkat pertama dalam daftar isi dengan cetak tebal.
Penanda sub bagian pendek dan bermakna yang terlihat "indah" di bilah URL peramban seperti
#heading--1-1
bukan penanda yang berisi bagian yang diubah dari tajuk yang sebenarnya.Kode ini menggunakan judul H2 (
## …
) untuk bagian, judul H3 (### …
) untuk sub-judul dll. Ini membuat kode sumber lebih mudah dibaca karena## …
memberikan petunjuk visual yang lebih kuat ketika menggulir melalui dibandingkan dengan kasus di mana bagian akan mulai dengan judul H1 (# …
). Itu masih konsisten secara logis saat Anda menggunakan judul H1 untuk judul dokumen itu sendiri.Akhirnya, kami menambahkan aturan horizontal yang bagus untuk memisahkan daftar isi dari konten yang sebenarnya.
Untuk informasi lebih lanjut tentang teknik ini dan bagaimana kami menggunakannya di dalam wacana perangkat lunak forum , lihat di sini .
sumber
Saya menulis skrip python yang mem-parsing file penurunan harga dan menampilkan daftar isi sebagai daftar penurunan harga: md-to-toc
Tidak seperti skrip lain yang saya temukan, md-to-toc dengan benar mendukung judul rangkap. Itu juga tidak memerlukan koneksi internet, jadi itu berfungsi pada file md, bukan hanya yang tersedia dari repo publik.
sumber
Dalam Visual Studio Code (VSCode) Anda dapat menggunakan ekstensi Markdown All in One .
Setelah diinstal, ikuti langkah-langkah di bawah ini:
sumber
Saya baru saja mulai melakukan hal yang sama (mencatat dalam Markdown). Saya menggunakan Sublime Text 2 dengan plugin MarkdownPreview . Dukungan parser penurunan harga bawaan
[TOC]
.sumber
Typora menghasilkan Daftar Isi dengan menambahkan
[TOC]
ke dokumen Anda.sumber
Di Gitlab, penurunan harga mendukung ini:
[[_TOC_]]
sumber
Cukup gunakan editor teks Anda dengan sebuah plugin.
Editor Anda sangat mungkin memiliki paket / plugin untuk menangani ini untuk Anda. Misalnya, di Emacs , Anda dapat menginstal generator TOC markdown-toc . Kemudian saat Anda mengedit, panggil saja
M-x markdown-toc-generate-or-refresh-toc
. Ikatan kunci itu layak jika Anda ingin sering melakukannya. Ini bagus untuk menghasilkan TOC sederhana tanpa mencemari dokumen Anda dengan jangkar HTML.Editor lain memiliki plugin yang serupa, jadi daftar yang populer adalah seperti:
sumber
Berdasarkan jawaban albertodebortoli dibuat fungsi dengan pemeriksaan tambahan dan penggantian tanda baca.
sumber
MultiMarkdown 4.7 memiliki {{TOC}} makro yang menyisipkan daftar isi.
sumber
Bagi saya, solusi yang diusulkan oleh @Tum bekerja seperti pesona untuk daftar isi dengan 2 level. Namun, untuk level 3 tidak berhasil. Itu tidak menampilkan tautan seperti untuk 2 tingkat pertama, itu menampilkan teks biasa
3.5.1. [bla bla bla](#blablabla) <br>
sebagai gantinya.Solusi saya adalah tambahan untuk solusi @Tum (yang sangat sederhana) untuk orang-orang yang membutuhkan daftar isi dengan 3 level atau lebih.
Pada tingkat kedua, tab sederhana akan melakukan indentasi dengan benar untuk Anda. Tetapi tidak mendukung 2 tab. Sebagai gantinya, Anda harus menggunakan satu tab dan menambahkan banyak
Anda butuhkan untuk menyelaraskan level ke-3 dengan benar.Berikut ini adalah contoh menggunakan 4 level (semakin tinggi levelnya, menjadi mengerikan):
Ini memberikan hasil berikut ini di mana setiap elemen dari daftar isi adalah tautan ke bagian terkait. Perhatikan juga
<br>
untuk menambahkan baris baru alih-alih berada di baris yang sama.Daftar Isi
1.1. Sub-Judul
1.1.1. Sub-Judul
1.1.1.1. Sub-Sub-Judul
Judul
Tajuk 1
Sub-Judul
Tajuk 2
Sub-Judul
Tajuk 3
Sub-Sub-JudulTajuk 4
sumber
Tergantung pada alur kerja Anda, Anda mungkin ingin melihat strapdown
Itu adalah garpu dari yang asli ( http://strapdownjs.com ) yang menambahkan generasi daftar isi.
Ada file konfigurasi apache pada repo (mungkin belum diperbarui dengan benar) untuk membungkus penurunan harga dengan cepat, jika Anda lebih suka tidak menulis dalam file html.
sumber
Saya tidak yakin, apa dokumentasi resmi untuk penurunan harga. Referensi Silang dapat ditulis hanya dalam kurung
[Heading]
, atau dengan kurung kosong[Heading][]
.Keduanya bekerja menggunakan pandoc . Jadi saya membuat skrip bash cepat, yang akan menggantikan $ TOC dalam file md dengan TOC-nya. (Anda perlu envsubst, yang mungkin bukan bagian dari distro Anda)
sumber
Jika Anda menggunakan Eclipse, Anda dapat menggunakan cara pintas Ctrl+ O(garis besar), ini akan menunjukkan padanan daftar isi dan memungkinkan untuk mencari di judul bagian (pelengkapan otomatis).
Anda juga dapat membuka tampilan Outline (Window -> Show View -> Outline) tetapi tidak memiliki pencarian autocomplete.
sumber
Gunakan toc.py yang merupakan skrip python kecil yang menghasilkan daftar isi untuk penurunan harga Anda.
Pemakaian:
<toc>
mana Anda ingin daftar isi ditempatkan.$python toc.py README.md
(Gunakan nama file penurunan harga Anda alih-alih README.md )Bersulang!
sumber
Saya telah menggunakan https://github.com/ekalinin/github-markdown-toc yang menyediakan utilitas baris perintah yang secara otomatis menghasilkan daftar isi dari dokumen penurunan harga.
Tidak ada plugin, atau makro atau dependensi lainnya. Setelah menginstal utilitas, cukup tempelkan output utilitas ke lokasi di dokumen tempat Anda ingin daftar isi Anda. Sangat mudah digunakan.
sumber
Jika file Penurunan harga Anda akan ditampilkan dalam repo di bitbucket.org, Anda harus menambahkan
[TOC]
di lokasi di mana Anda ingin daftar isi Anda. Kemudian akan dihasilkan secara otomatis. Info lebih lanjut di sini:https://confluence.atlassian.com/bitbucket/add-a-table-of-contents-to-a-wiki-221451163.html
sumber
Ada skrip Ruby yang disebut mdtoc.rb yang dapat secara otomatis membuat Daftar Isi GFM, dan mirip tapi sedikit berbeda dengan beberapa skrip lain yang diposting di sini.
Diberikan file Penurunan harga input seperti:
Ini menghasilkan daftar isi ini:
Lihat juga posting blog saya tentang topik ini.
sumber