Not almak için markdown kullanmaya başladım.

Ben işaretleme notlarımı ve güzel görmek için işaretli kullanın.

Ama notlarım uzadıkça istediğimi bulmakta zorlanıyorum.

Markdown tablolar oluşturabilir biliyorum, ama bölümlere atlar veya markdown sayfa bölümleri tanımlayan içindekiler tablosu oluşturmak mümkün mü?

Alternatif olarak, bu tür şeyler yapabilen markdown okuyucular / editörler var. Arama da sahip olmak iyi bir özellik olacaktır.

Kısacası, harika not alma aracım ve bir kitap yazmak gibi işlevler yapmak istiyorum.

MultiMarkdown Composer , düzenleme sırasında yardımcı olacak bir içindekiler tablosu oluşturuyor gibi görünüyor.

İçindekiler oluşturabilecek bir veya başka kütüphane de olabilir: bkz. Python Markdown İçindekiler Uzantısı .

Bunu deneyebilirsiniz.

# Table of Contents
1. [Example](#example)
2. [Example2](#example2)
3. [Third Example](#third-example)
4. [Fourth Example](#fourth-examplehttpwwwfourthexamplecom)


## Example
## Example2
## Third Example
## [Fourth Example](http://www.fourthexample.com) 

İşte kullanışlı bir yöntem. Herhangi bir MarkDown editöründe tıklanabilir referanslar üretmelidir.

# Table of contents
1. [Introduction](#introduction)
2. [Some paragraph](#paragraph1)
    1. [Sub paragraph](#subparagraph1)
3. [Another paragraph](#paragraph2)

## This is the introduction <a name="introduction"></a>
Some introduction text, formatted in heading 2 style

## Some paragraph <a name="paragraph1"></a>
The first paragraph text

### Sub paragraph <a name="subparagraph1"></a>
This is a sub paragraph, formatted in heading 3 style

## Another paragraph <a name="paragraph2"></a>
The second paragraph text

üretir:

İçindekiler

1. Giriş
2. Bazı paragraflar
   1. Alt paragraf
3. Başka bir paragraf

Bu giriş

Başlık 2 stilinde biçimlendirilmiş bazı giriş metinleri

Bazı paragraflar

İlk paragraf metni

Alt paragraf

Bu, başlık 3 stilinde biçimlendirilmiş bir alt paragraftır

Başka bir paragraf

İkinci paragraf metni

İçin Visual Studio Kod kullanıcıları, iyi bir fikir kullanmaktır Markdown TOK eklentisi.

Yüklemek için, VS Code Quick Open ( Control/⌘+ P) uygulamasını başlatın , aşağıdaki komutu yapıştırın ve enter tuşuna basın.

ext install markdown-toc

Ve TOC oluşturmak için, komut paletini (açık Control/⌘+ Shift+ P) ve seçmek Markdown TOC:Insert/Update optionveya kullanım Control/⌘+ MT.

Bir etiketleme dosyasından TOK oluşturmak için bu yakut betiği deneyebilirsiniz .

 #!/usr/bin/env ruby

require 'uri'

fileName = ARGV[0]
fileName = "README.md" if !fileName

File.open(fileName, 'r') do |f|
  inside_code_snippet = false
  f.each_line do |line|
    forbidden_words = ['Table of contents', 'define', 'pragma']
    inside_code_snippet = !inside_code_snippet if line.start_with?('```')
    next if !line.start_with?("#") || forbidden_words.any? { |w| line =~ /#{w}/ } || inside_code_snippet

    title = line.gsub("#", "").strip
    href = URI::encode title.gsub(" ", "-").downcase
    puts "  " * (line.count("#")-1) + "* [#{title}](\##{href})"
  end
end

TOK'nuzu oluşturmanın 2 yolu vardır sizin markdown belgede (özet).

1. Elle

# My Table of content
- [Section 1](#id-section1)
- [Section 2](#id-section2)

<div id='id-section1'/>
## Section 1
<div id='id-section2'/>
## Section 2

2. Programlı olarak

Örneğin, sizin için özet oluşturan bir komut dosyası kullanabilir, github'daki projeme bakabilirsiniz - summarizeMD -

Ayrıca diğer komut dosyası / npm modülü (örneğin doctoc ) denedim ama hiç kimse çalışma çapa ile bir TOC yeniden.

# Table of Contents
1. [Example](#example)
2. [Example2](#example2)
3. [Third Example](#third-example)

## Example [](#){name=example}
## Example2 [](#){name=example2}
## [Third Example](#){name=third-example}

Fazladan işaretleme kullanıyorsanız, bağlantılara, başlıklara, kod çitlerine ve resimlere özel özellikler ekleyebileceğinizi unutmayın.
https://michelf.ca/projects/php-markdown/extra/#spe-attr

Farklı Markdown ayrıştırıcıları tarafından oluşturulan bağlantı etiketleri çift değildir.

Markdown ayrıştırıcıları GFM (GitHub Flavored Markdown) veya Redcarpet ile çalışıyorsanız, içindekiler tablosunu işlemek için bir Vim eklentisi yazdım.

Özellikleri

1. Markdown dosyaları için içindekiler tablosu oluşturun.

   Desteklenen Markdown ayrıştırıcıları:

   • GFM (GitHub Aromalı Markdown)
   • Kırmızı halı

2. Mevcut içindekiler tablosunu güncelleyin.

3. Kayıt sırasında mevcut içindekileri otomatik olarak güncelle.

Ekran görüntüleri

kullanım

İçindekiler tablosu oluştur

İmleci içindekiler tablosunu eklemek istediğiniz satıra getirin, ardından size uygun bir komut yazın. Komut, imleçten sonra içindekiler tablosuna başlıklar oluşturur.

1. :GenTocGFM

   İçindekiler tablosunu GFM bağlantı stilinde oluşturun.

   Bu komut, README.md gibi GitHub depolarındaki Markdown dosyaları ve GitBook için Markdown dosyaları için uygundur.

2. :GenTocRedcarpet

   İçindekiler tablosunu Redcarpet bağlantı stilinde oluşturun.

   Bu komut Jekyll için uygundur veya Markcar ayrıştırıcısı olarak Redcarpet'i başka herhangi bir yerde kullanır.

   Görüntüleyebilir burada GFM ve redcarpet tarzı toc bağlantıları arasındaki farkları bilmek.

Mevcut içindekileri manuel olarak güncelleme

Genellikle bunu yapmanız gerekmez, mevcut içindekiler tablosu varsayılan olarak kaydedildiğinde otomatik olarak güncellenir. Manuel olarak yapmak istiyorsanız, sadece :UpdateToccommand komutunu kullanın.

Yüklemeler ve belgeler

https://github.com/mzlogin/vim-markdown-toc

Ayrıca pandoc, "bir biçimlendirme biçimini diğerine" dönüştürmek için "İsviçre çakısı" kullanabilirsiniz . --tocArgümanı sağlarsanız çıktı belgesinde otomatik olarak bir içerik tablosu oluşturabilir .

İpucu:html Çıktı içindekiler tablosu istiyorsanız , -sbağımsız bir belge oluşturan bir belge de sağlamanız gerekir .

Kabuk komut satırı örneği:

./pandoc -s --toc input.md -o output.html

Atom ( biz bu iş parçacığı nasıl buldum) README.mddosyaları yapma bizim yararına :

apm install markdown-toc

https://atom.io/packages/markdown-toc

Eğer bir javascript / node.js aracı kullanmak isterseniz, bir göz atın markdown-toc .

Bu bash tek astarı kullanarak üretebilirsiniz. İşaretleme dosyanızın çağrıldığını varsayar FILE.md.

echo "## Contents" ; echo ; 
cat FILE.md | grep '^## ' | grep -v Contents | sed 's/^## //' | 
  while read -r title ; do 
    link=$(echo $title | tr 'A-Z ' 'a-z-') ; 
    echo "- [$title](#$link)" ; 
    done

python-markdownBaşlıkları almak için ayrıştırıcısını kullanan bir uzantı kodladım ve yerel bağlantılarla Markdown formatlı sırasız liste olarak bir TOC çıktısı aldım . Dosya

• md_toc.py ( md_toc.py idi )

... ve markdown/extensions/markdown kurulumunda dizine yerleştirilmelidir . Ardından, tek yapmanız gereken referans olarak <a>bir id="..."özniteliğe sahip bağlantı etiketleri yazmaktır - böylece böyle bir giriş metni için:

$ cat test.md 
Hello
=====

## <a id="sect one"></a>SECTION ONE ##

something here

### <a id='sect two'>eh</a>SECTION TWO ###

something else

#### SECTION THREE

nothing here

### <a id="four"></a>SECTION FOUR

also...

... eklenti şu şekilde adlandırılabilir:

$ python -m markdown -x md_toc test.md 
* Hello
    * [SECTION ONE](#sect one)
        * [SECTION TWO](#sect two)
            * SECTION THREE
        * [SECTION FOUR](#four)

... ve sonra bu toc'u işaretleme belgenize yapıştırabilirsiniz (veya metin düzenleyicinizde, şu anda açık olan belgede komut dosyasını çağıran ve sonuçta ortaya çıkan İçindekileri aynı belgeye ekleyen bir kısayol kullanabilirsiniz).

Eski sürümlerinin python-markdownbir __main__.pymodülü olmadığını ve bu nedenle yukarıdaki gibi komut satırı çağrısının bu sürümler için çalışmayacağını unutmayın.

Diğer cevaplarda belirtildiği gibi, otomatik olarak içindekiler tablosu oluşturmanın birden çok yolu vardır. Çoğu açık kaynaklı yazılımdır ve ihtiyaçlarınıza göre uyarlanabilir.

Ne eksik, ancak, Markdown tarafından sağlanan sınırlı seçenekleri kullanarak, içindekiler tablosu için görsel olarak çekici bir biçimlendirme. Aşağıdakileri bulduk:

kod

## Content

**[1. Markdown](#heading--1)**

  * [1.1. Markdown formatting cheatsheet](#heading--1-1)
  * [1.2. Markdown formatting details](#heading--1-2)

**[2. BBCode formatting](#heading--2)**

  * [2.1. Basic text formatting](#heading--2-1)

      * [2.1.1. Not so basic text formatting](#heading--2-1-1)

  * [2.2. Lists, Images, Code](#heading--2-2)
  * [2.3. Special features](#heading--2-3)

----

Belgenizin içine, hedef alt bölüm işaretleyicilerini şu şekilde yerleştirirsiniz:

<div id="heading--1-1"/>
### 1.1. Markdown formatting cheatsheet

Markdown'u nerede ve nasıl kullandığınıza bağlı olarak, aşağıdakiler de çalışmalı ve daha güzel görünen Markdown kodu sağlar:

### 1.1. Markdown formatting cheatsheet <a name="heading--1-1"/>

Örnek oluşturma

içerik

1. İşaretleme

• 1.1. Markdown biçimlendirme hileleri sayfası
• 1.2. İşaretleme biçimlendirme ayrıntıları

2. BBCode biçimlendirmesi

• 2.1. Temel metin biçimlendirme

  • 2.1.1. Çok basit metin biçimlendirmesi değil

• 2.2. Listeler, Resimler, Kod

• 2.3. ÖZELLİKLER

---

Avantajları

• İhtiyacınız olduğu kadar çok bölüm ve alt bölüm ekleyebilirsiniz. İçindekiler bölümünde, bunlar daha derin düzeylerde iç içe sıralanmamış listeler olarak görünecektir.

• Sıralı listelerin kullanımı yok. Bunlar bir girinti oluşturur, sayıyı bağlamaz ve "1.1" gibi ondalık sınıflandırma numaralandırması oluşturmak için kullanılamaz.

• İlk seviye için liste kullanımı yok. Burada, sırasız bir liste kullanmak mümkündür, ancak gerekli değildir: girinti ve madde işareti sadece görsel karmaşa ekler ve burada işlev yoktur, bu nedenle ilk ToC seviyesi için bir liste kullanmayız.

• İçindekiler bölümündeki birinci düzey bölümlere kalın baskı ile görsel vurgu.

• #heading--1-1Gerçek başlığın dönüştürülmüş parçalarını içeren işaretçiler yerine tarayıcının URL çubuğunda "güzel" görünen kısa, anlamlı alt bölüm işaretçileri .

• Kod, ## …bölümler için H2 başlıkları ( ), ### …alt başlıklar vb. İçin H3 başlıkları ( ) kullanır. Bu, kaynak kodunun okunmasını kolaylaştırır, çünkü ## …bölümler H1 başlıkları ( # …). Belge başlığının kendisi için H1 başlığını kullandığınızda yine de mantıksal olarak tutarlıdır.

• Son olarak, içindekiler bölümünü gerçek içerikten ayırmak için güzel bir yatay kural ekliyoruz.

Bu teknikle ve nasıl forum yazılımı içinde kullanmak hakkında daha fazla bilgi için Söylem , burada bkz .

Bir markdown dosyasını ayrıştıran ve içindekiler listesini markdown listesi olarak çıkaran bir python betiği yazdım: md-to-toc

Bulduğum diğer komut dosyalarının aksine, md-to-toc yinelenen başlıkları doğru bir şekilde destekler. Ayrıca bir internet bağlantısı gerektirmez, bu nedenle sadece halka açık bir depoda bulunanlar değil, herhangi bir md dosyasında çalışır.

Visual Studio Code'da (VSCode) Markdown All in One uzantısını kullanabilirsiniz .

Kurulduktan sonra aşağıdaki adımları izleyin:

1. Basın CTRL+SHIFT +P
2. İşaretleme Seç : İçindekiler Oluştur

Ben de aynı şeyi yapmaya başladım (Markdown'da not al). MarkdownPreview eklentisi ile Sublime Text 2 kullanıyorum . Yerleşik etiketleme ayrıştırıcısını destekler [TOC].

Typora , belgenize ekleyerek İçindekiler Tablosu oluşturur [TOC].

Gitlab'da markdown bunu destekler: [[_TOC_]]

Metin düzenleyicinizi bir eklenti ile kullanın.

Editörünüzde büyük olasılıkla bunu sizin için halletmek için bir paket / eklenti var. Örneğin, Emacs'ta , markdown-toc TOK üretecini kurabilirsiniz . Sonra düzenleme yaparken, sadece tekrar tekrar arayınM-x markdown-toc-generate-or-refresh-toc . Sık sık yapmak istiyorsanız, anahtar bir bağlamaya değer. Dokümanınızı HTML çapalarıyla kirletmeden basit bir TOK oluşturmada iyidir.

Diğer editörlerin benzer eklentileri vardır, bu yüzden popüler liste şuna benzer:

• Emacs : markdown-toc
• Vim : markdown-toc
• Atom : markdown-toc
• VSCode : markdown -toc

Albertodebortoli cevabına dayanarak ek kontroller ve noktalama işaretlerinin değiştirilmesi ile fonksiyon oluşturuldu.

# @fn       def generate_table_of_contents markdown # {{{
# @brief    Generates table of contents for given markdown text
#
# @param    [String]  markdown Markdown string e.g. File.read('README.md')
#
# @return   [String]  Table of content in markdown format.
#
def generate_table_of_contents markdown
  table_of_contents = ""
  i_section = 0
  # to track markdown code sections, because e.g. ruby comments also start with #
  inside_code_section = false
  markdown.each_line do |line|
    inside_code_section = !inside_code_section if line.start_with?('```')

    forbidden_words = ['Table of contents', 'define', 'pragma']
    next if !line.start_with?('#') || inside_code_section || forbidden_words.any? { |w| line =~ /#{w}/ }

    title = line.gsub("#", "").strip
    href = title.gsub(/(^[!.?:\(\)]+|[!.?:\(\)]+$)/, '').gsub(/[!.,?:; \(\)-]+/, "-").downcase

    bullet = line.count("#") > 1 ? " *" : "#{i_section += 1}."
    table_of_contents << "  " * (line.count("#") - 1) + "#{bullet} [#{title}](\##{href})\n"
  end
  table_of_contents
end

MultiMarkdown 4.7'de bir içindekiler tablosu ekleyen bir {{TOC}} makrosu vardır.

Benim için @Tum tarafından önerilen çözüm, 2 seviyeli bir içindekiler için bir cazibe gibi çalışıyor. Ancak, 3. seviye için işe yaramadı. İlk 2 seviye için bağlantıyı göstermedi, bunun 3.5.1. [bla bla bla](#blablabla) <br>yerine düz metni görüntüler .

Benim çözümüm 3 veya daha fazla seviyeli bir içindekiler tablosuna ihtiyaç duyan insanlar için @Tum (çok basit) çözümüne bir ektir.

İkinci düzeyde, basit bir sekme girintiyi sizin için doğru şekilde yapar. Ancak 2 sekmeyi desteklemiyor. Bunun yerine, bir sekme kullanmanız ve  ve 3. seviyeyi doğru bir şekilde hizalamak için gerektiği kadar gerekir.

İşte 4 seviye kullanan bir örnek (daha yüksek seviyeler, korkunç olur):

# Table of Contents
1. [Title](#title) <br>
    1.1. [sub-title](#sub_title) <br>
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1.1. [sub-sub-title](#sub_sub_title)
    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1.1.1.1. [sub-sub-sub-title](#sub_sub_sub_title)

# Title <a name="title"></a>
Heading 1

## Sub-Title <a name="sub_title"></a>
Heading 2

### Sub-Sub-Title <a name="sub_sub_title"></a>
Heading 3

#### Sub-Sub-Sub-Title <a name="sub_sub_sub_title"></a>
Heading 4

Bu, içindekiler tablosundaki her öğenin karşılık gelen bölüme bir bağlantı olduğu aşağıdaki sonucu verir. Ayrıca<br> yerine aynı satırda olmanın yeni bir satır eklemek için.

İçindekiler

1. Başlık
   1.1. Alt Başlık
          1.1.1. Alt-Alt Başlık
                    1.1.1.1. Alt Alt Alt Başlığı

Başlık

Başlık 1

Alt yazı

Başlık 2

Alt Alt Başlığı

Başlık 3

Başlık 4

İş akışınıza bağlı olarak, kayışa bakmak isteyebilirsiniz

Bu , içerik tablosunun oluşturulmasını ekleyen orijinalin ( http://strapdownjs.com ) bir çatalı .

Html dosyalarına yazmayı tercih etmiyorsanız, repo üzerinde düz işaretlemeyi sarmak için repoda bir apache yapılandırma dosyası (henüz düzgün şekilde güncellenmemiş olabilir) var.

Emin değilim, markdown için resmi belgeler nedir. Çapraz Referans sadece parantez içinde [Heading]veya boş parantez ile yazılabilir [Heading][].

Her ikisi de pandoc kullanarak çalışır . Bu yüzden md dosyasında $ TOC'yi TOC ile değiştirecek hızlı bir bash betiği oluşturdum . (Envsubst'a ihtiyacınız olacak, bu dağıtımınızın bir parçası olmayabilir)

#!/bin/bash
filename=$1
__TOC__=$(grep "^##" $filename | sed -e 's/ /1. /;s/^##//;s/#/   /g;s/\. \(.*\)$/. [\1][]/')
export __TOC__
envsubst '$__TOC__' < $filename

Kullanmak edersek Eclipse kullanabileceğiniz Ctrl+ O(anahat) kısayol bu içindekiler eşdeğer gösterip bölüm başlıkları (otomatik tamamlama) arama yapmak için izin verecektir.

Anahat görünümünü de açabilirsiniz (Pencere -> Görünümü Göster -> Anahat) ancak otomatik tamamlama araması yoktur.

İşaretlemeniz için içindekiler tablosu oluşturan küçük bir python betiği olan toc.py komutunu kullanın .

Kullanımı:

• Markdown dosyanıza <toc>içindekiler tablosunun yerleştirilmesini istediğiniz yere ekleyin .
• $python toc.py README.md( İşaretleme dosya adınızı README.md yerine kullanın )

Şerefe!

Bir işaretleme belgesinden içindekiler tablosunu otomatik olarak üreten bir komut satırı yardımcı programı sağlayan https://github.com/ekalinin/github-markdown-toc kullandım .

Eklenti, makro veya diğer bağımlılıklar yok. Yardımcı programı yükledikten sonra, yardımcı programın çıktısını belgedeki içindekiler tablonuzu istediğiniz yere yapıştırmanız yeterlidir. Kullanımı çok basit.

$ cat README.md | ./gh-md-toc -

Markdown dosyanız bitbucket.org'daki bir repoda görüntülenecekse, [TOC]içindekiler tablonuzu istediğiniz yere eklemeniz gerekir . Daha sonra otomatik olarak oluşturulacaktır. Daha fazla bilgi burada:

https://confluence.atlassian.com/bitbucket/add-a-table-of-contents-to-a-wiki-221451163.html

Bir GFM Markdown İçindekiler'i otomatik olarak oluşturabilen mdtoc.rb adlı bir Ruby betiği vardır ve burada yayınlanan diğer komut dosyalarına benzer ancak biraz farklıdır.

Aşağıdaki gibi bir Markdown dosyası verildi:

# Lorem Ipsum

Lorem ipsum dolor sit amet, mei alienum adipiscing te, has no possit delicata. Te nominavi suavitate sed, quis alia cum no, has an malis dictas explicari. At mel nonumes eloquentiam, eos ea dicat nullam. Sed eirmod gubergren scripserit ne, mei timeam nonumes te. Qui ut tale sonet consul, vix integre oportere an. Duis ullum at ius.

## Et cum

Et cum affert dolorem habemus. Sale malis at mel. Te pri copiosae hendrerit. Cu nec agam iracundia necessitatibus, tibique corpora adipisci qui cu. Et vix causae consetetur deterruisset, ius ea inermis quaerendum.

### His ut

His ut feugait consectetuer, id mollis nominati has, in usu insolens tractatos. Nemore viderer torquatos qui ei, corpora adipiscing ex nec. Debet vivendum ne nec, ipsum zril choro ex sed. Doming probatus euripidis vim cu, habeo apeirian et nec. Ludus pertinacia an pro, in accusam menandri reformidans nam, sed in tantas semper impedit.

### Doctus voluptua

Doctus voluptua his eu, cu ius mazim invidunt incorrupte. Ad maiorum sensibus mea. Eius posse sonet no vim, te paulo postulant salutatus ius, augue persequeris eum cu. Pro omnesque salutandi evertitur ea, an mea fugit gloriatur. Pro ne menandri intellegam, in vis clita recusabo sensibus. Usu atqui scaevola an.

## Id scripta

Id scripta alterum pri, nam audiam labitur reprehendunt at. No alia putent est. Eos diam bonorum oportere ad. Sit ad admodum constituto, vide democritum id eum. Ex singulis laboramus vis, ius no minim libris deleniti, euismod sadipscing vix id.

Bu içindekiler tablosunu oluşturur:

$ mdtoc.rb FILE.md 
#### Table of contents

1. [Et cum](#et-cum)
    * [His ut](#his-ut)
    * [Doctus voluptua](#doctus-voluptua)
2. [Id scripta](#id-scripta)

Bu konudaki blog yayınımı da görün .