Sto scrivendo un documento Markdown di grandi dimensioni e vorrei mettere all'inizio una sorta di sommario che fornirà collegamenti a varie posizioni nel documento. Come posso fare questo?

Ho provato a usare

[a link](# MyTitle)

dove si MyTitletrova un titolo all'interno del documento e questo non ha funzionato.

In pandoc , se si utilizza l'opzione --tocnella produzione di html, verrà prodotto un sommario con collegamenti alle sezioni e di nuovo al sommario dalle intestazioni delle sezioni. È simile con gli altri formati che scrive pandoc, come LaTeX, rtf, rst, ecc. Quindi con il comando

pandoc --toc happiness.txt -o happiness.html

questo po 'di markdown:

% True Happiness

Introduction
------------

Many have posed the question of true happiness.  In this blog post we propose to
solve it.

First Attempts
--------------

The earliest attempts at attaining true happiness of course aimed at pleasure. 
Soon, though, the downside of pleasure was revealed.

produrrà questo come il corpo dell'html:

<h1 class="title">
    True Happiness
</h1>
<div id="TOC">
    <ul>
        <li>
            <a href="#introduction">Introduction</a>
        </li>
        <li>
            <a href="#first-attempts">First Attempts</a>
        </li>
    </ul>
</div>
<div id="introduction">
    <h2>
        <a href="#TOC">Introduction</a>
    </h2>
    <p>
        Many have posed the question of true happiness. In this blog post we propose to solve it.
    </p>
</div>
<div id="first-attempts">
    <h2>
        <a href="#TOC">First Attempts</a>
    </h2>
    <p>
        The earliest attempts at attaining true happiness of course aimed at pleasure. Soon, though, the downside of pleasure was revealed.
    </p>
</div>

Github analizza automaticamente i tag di ancoraggio dalle intestazioni. Quindi puoi fare quanto segue:

[Custom foo description](#foo)

# Foo

Nel caso precedente, l' Foointestazione ha generato un tag anchor con il nomefoo

Nota : solo uno #per tutte le dimensioni dell'intestazione, nessuno spazio tra #e nome dell'ancora , i nomi delle etichette di ancoraggio devono essere minuscoli e delimitati da trattini se composti da più parole .

[click on this link](#my-multi-word-header)

### My Multi Word Header

Aggiornare

Funziona anche fuori dagli schemi pandoc.

Sperimentando, ho trovato una soluzione usando <div…/>ma una soluzione ovvia è quella di posizionare il tuo punto di ancoraggio nella pagina dove preferisci, quindi:

<a name="abcde">

prima e

</a>

dopo la riga che si desidera "collegare" a. Quindi un link markdown come:

[link text](#abcde)

ovunque nel documento ti porta lì.

La <div…/>soluzione inserisce una divisione "fittizia" solo per aggiungere la idproprietà, e questo è potenzialmente dannoso per la struttura della pagina, ma la <a name="abcde"/>soluzione dovrebbe essere abbastanza innocua.

(PS: potrebbe essere OK inserire l'ancoraggio nella linea che si desidera collegare, come segue:

## <a name="head1">Heading One</a>

ma questo dipende da come Markdown lo tratta. Noto, ad esempio, che il formattatore di risposte Stack Overflow è contento di questo!)

Questo potrebbe essere un thread non aggiornato ma per creare collegamenti a documenti interni in markdown in Github usa ...
(NOTA: #title minuscolo)

    # Contents
     - [Specification](#specification) 
     - [Dependencies Title](#dependencies-title) 

    ## Specification
    Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. 

    ## Dependencies Title
    Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. Example text blah. Example text blah. 
Example text blah. Example text blah. 

È stata fatta una buona domanda, quindi ho modificato la mia risposta;

Un collegamento interno può essere fatto a qualsiasi dimensione titolo utilizzando - #, ##, ###, #### ho creato un esempio veloce sotto ... https://github.com/aogilvie/markdownLinkTest

Sì, Markdown fa questo, ma è necessario specificare il nome anchor <a name='xyx'>.

un esempio completo,

questo crea il collegamento
[tasks](#tasks)

più avanti nel documento, si crea l'ancora con nome (come si chiama).

<a name="tasks">
   my tasks
</a>

nota che potresti anche avvolgerlo attorno all'intestazione.

<a name="tasks">
### Agile tasks (created by developer)
</a>

Il manuale pandoc spiega come collegarsi alle intestazioni, usando il loro identificatore. Non ho verificato il supporto di questo da altri parser, ma è stato riferito che non funziona su Github .

L'identificatore può essere specificato manualmente:

## my heading text {#mht}
Some normal text here,
including a [link to the header](#mht).

oppure puoi utilizzare l'identificatore generato automaticamente (in questo caso #my-heading-text). Entrambi sono spiegati in dettaglio nel manuale di Pandand .

NOTA : funziona solo quando si converte in HTML , LaTex , ConTeXt , Textile o AsciiDoc .

Alcune cose aggiuntive da tenere a mente se ti capita mai di immaginarti con simboli all'interno delle intestazioni che vuoi navigare verso ...

# What this is about


------


#### Table of Contents


- [About](#what-this-is-about)

- [⚡ Sunopsis](#9889-tldr)

- [:gear: Grinders](#it-grinds-my-gears)

- [Attribution]


------


## ⚡ TLDR


Words for those short on time or attention.


___


## It Grinds my :gear:s


Here _`:gear:`_ is not something like ⚙ or ⛭


___


## ⛤ Attribution


Probably to much time at a keyboard



[Attribution]: #9956-attribution

... cose come #, ;, &, e :della voce stringhe sono in genere vengono ignorate / strisce invece di sfuggita, e si può anche usare la citazione link di stile per rendere rapido utilizzo più facile.

Appunti

GitHub supporta la :word:sintassi in commit, file readme, ecc. Vedi gist (da rxaviers) se l'utilizzo di em è interessante lì.

E praticamente ovunque è possibile utilizzare decimali o esadecimali per i browser moderni; il cheat-sheet di w3schools è molto utile , soprattutto se usare CSS ::beforeo ::afterpseudo-elementi con simboli è più il tuo stile.

Punti bonus?

Nel caso in cui qualcuno si chiedesse come immagini e altri collegamenti all'interno di un'intestazione vengono analizzati in un id...

- [Imaged](#alt-textbadge__examplehttpsexamplecom-to-somewhere)


## [![Alt Text][badge__example]](https://example.com) To Somewhere


[badge__example]:
  https://img.shields.io/badge/Left-Right-success.svg?labelColor=brown&logo=stackexchange
  "Eeak a mouse!"

Avvertenze

Il rendering di MarkDown differisce da un luogo all'altro, quindi cose come ...

## methodName([options]) => <code>Promise</code>

... su GitHub avrà un elemento idcome ...

id="methodnameoptions--promise"

... dove come vaniglia servizi igienico-sanitari comporterebbe un iddi ...

id="methodnameoptions-codepromisecode"

... il che significa che scrivere o compilare file MarkDown dai modelli richiede sia il targeting di un modo di slugifeing , sia l'aggiunta di configurazioni e logica di script per i vari modi intelligenti che piacciono a come pulire il testo dell'intestazione.

Soluzioni universali

Questa domanda sembra avere una risposta diversa in base all'implementazione del markdown.
In effetti, la documentazione ufficiale di Markdown tace su questo argomento.
In tali casi, e se si desidera una soluzione portatile, è possibile utilizzare HTML.

Prima di qualsiasi intestazione o nella stessa riga di intestazione, definire un ID utilizzando un tag HTML.
Ad esempio: <a id="Chapter1"></a>
vedrai questo nel tuo codice ma non nel documento renderizzato.

Esempio completo:

Vedi un esempio completo (online e modificabile) qui .

## Content

* [Chapter 1](#Chapter1)
* [Chapter 2](#Chapter2)

<div id="Chapter1"></div>
## Chapter 1

Some text here.  
Some text here.
Some text here.

## Chapter 2 <span id="Chapter2"><span>

Some text here.  
Some text here.
Some text here.

Per provare questo esempio, è necessario aggiungere ulteriore spazio tra l'elenco dei contenuti e il primo capitolo o ridurre l'altezza della finestra.
Inoltre, non utilizzare spazi nel nome degli ID.

Non esiste una direttiva di questo tipo nelle specifiche Markdown. Scusate.

Gitlab utilizza GitLab Flavored Markdown (GFM)

Qui "tutte le intestazioni renderizzate da Markdown ottengono automaticamente gli ID"

Si può usare il mouse per:

• sposta il mouse sopra l'intestazione
• sposta il mouse sopra il selettore al passaggio del mouse che diventa visibile a sinistra dall'intestazione

• copia e salva il link usando il tasto destro del mouse

  Ad esempio nel file README.md ho l'intestazione:

## series expansion formula of the Boettcher function

che fornisce un collegamento:

https://gitlab.com/adammajewski/parameter_external_angle/blob/master/README.md#series-expansion-formula-of-the-boettcher-function

Il prefisso può essere rimosso, quindi il link qui è semplicemente

file#header

che qui significa:

README.md#series-expansion-formula-of-the-boettcher-function

Ora può essere usato come:

[series expansion formula of the Boettcher function](README.md#series-expansion-formula-of-the-boettcher-function)

Si può anche farlo manualmente: sostituire gli spazi con il segno meno.

L'esempio dal vivo è qui

Usando kramdown, sembra che funzioni bene:

[I want this to link to foo](#foo)
....
....
{: id="foo"}
### Foo are you?

Vedo che è stato menzionato quello

[foo][#foo]
....
#Foo

funziona in modo efficiente, ma il primo potrebbe essere una buona alternativa per elementi oltre alle intestazioni o alle intestazioni con più parole.

Poiché MultiMarkdown è stato menzionato come opzione nei commenti.

In MultiMarkdown la sintassi per un collegamento interno è semplice.

Per qualsiasi intestazione nel documento è sufficiente fornire il nome dell'intestazione in questo formato [heading][]per creare un collegamento interno.

Maggiori informazioni qui: Riferimenti incrociati MultiMarkdown-5 .

Riferimenti incrociati

Una caratteristica spesso richiesta era la possibilità che Markdown gestisse automaticamente i collegamenti all'interno dei documenti con la stessa facilità con cui gestiva i collegamenti esterni. A questo scopo, ho aggiunto la possibilità di interpretare [Some Text] [] come un collegamento incrociato, se esiste un'intestazione denominata "Some Text".

Ad esempio, [Metadata] [] ti porterà a # Metadata (o uno qualsiasi dei ## Metadata, ### Metadata, #### Metadata, ##### Metadata, ###### Metadata).

In alternativa, puoi includere un'etichetta facoltativa di tua scelta per aiutare a chiarire i casi in cui più intestazioni hanno lo stesso titolo:

### Panoramica [MultiMarkdownOverview] ##

Ciò consente di utilizzare [MultiMarkdownOverview] per fare riferimento in modo specifico a questa sezione e non a un'altra sezione denominata Panoramica. Funziona con intestazioni in stile atx o settext.

Se è già stata definita un'ancora utilizzando lo stesso ID utilizzato da un'intestazione, l'ancora definita ha la precedenza.

Oltre alle intestazioni all'interno del documento, è possibile fornire etichette per immagini e tabelle che possono essere utilizzate anche per riferimenti incrociati.

Alcuni altri giri sul <a name="">trucco:

<a id="a-link"></a> Title
------

#### <a id="a-link"></a> Title (when you wanna control the h{N} with #'s)

Oltre alle risposte di cui sopra,

Quando si imposta l'opzione number_sections: truenell'intestazione YAML:

number_sections: TRUE

RMarkdown numera automaticamente le sezioni.

Per fare riferimento a quelle sezioni autonumerate è sufficiente inserire quanto segue nel file R Markdown:

[My Section]

Dov'è My Sectionil nome della sezione

Questo sembra funzionare indipendentemente dal livello di sezione:

# My section

## My section

### My section