Tabella dei contenuti markdown

Tabella dei contenuti markdown
Un sommario è un elenco di titoli per i capitoli o le sezioni di un documento, disposti in base alla loro sequenza di aspetto. In markdown, è possibile creare manualmente un contenuto o generarne uno automaticamente. Per questa lezione, praticheremo la costruzione manuale di Markdown TOC usando la sintassi dello script nativo di Markdown.

Creazione di un contenuto del tavolo in Markdown:

Una tabella di contenuto può essere creata in un documento utilizzando la sintassi di Markdown nativa. Questo tutorial ci aiuterà a imparare la generazione della tabella dei contenuti Markdown.

Per l'implementazione pratica degli script di Markdown, abbiamo bisogno di uno strumento che supporti il ​​linguaggio di Markdown. Abbiamo scelto il codice Visual Studio per la compilazione dei codici di esempio. Dopo aver lanciato lo strumento, abbiamo creato un nuovo file e impostato il suo tipo su "Markdown."Per aprire la finestra Anteprima, basta premere i tasti" Ctrl+Shift+V ". Ora abbiamo un file "markdown" e una finestra di anteprima corrispondente ad esso.

Lo strumento per la compilazione dello script è ora impostato. La creazione della tabella del contenuto inizierebbe in seguito. Nel file di markdown, abbiamo creato prima un'intestazione. Per la creazione di un'intestazione, dobbiamo aggiungere un simbolo hash (#). L'aggiunta di un singolo hash (#) si riferisce all'intestazione di primo livello. Dopo il simbolo hash, è necessario dare uno spazio prima di scrivere il testo della tua testa. Il testo che abbiamo specificato per l'intestazione del nostro documento è "Sommario."Questo creerà un'intestazione con la dimensione H1 nella parte superiore della nostra pagina web.

Quindi abbiamo saltato alcune righe prima di scrivere la sceneggiatura successiva. Ora creeremo un elenco di intestazioni di contenuti disponibili nel documento. Per la creazione di un elenco di markdown, abbiamo due scelte: se creare elenchi ordinati o elenchi non ordinati. Per la generazione di elenchi, dobbiamo scrivere un valore numerico e aggiungere un punto (.) immediatamente dopo di esso. Quindi, dopo uno spazio, menziona gli elementi dell'elenco. Per gli elementi dell'elenco qui, dobbiamo creare collegamenti a markdown che ci indirizzeranno a una sezione specifica del documento quando facciamo clic su di essi.

Quindi, abbiamo aggiunto il primo elemento dell'elenco con il valore numerico "1" e quindi per creare il collegamento a una sezione della pagina, abbiamo scritto per la prima volta il titolo di intestazione tra parentesi quadrate seguite da parentesi rotonde che terranno un hash (#) simbolo e il titolo dell'intestazione a cui può dirigere l'utente. Non è possibile dare alcuna scheda o spazio nelle parentesi graffe rotonde quando si aggiungono collegamenti a una parte del documento. Invece, puoi usare i trattini (-) dove necessario come sostituto per gli spazi. Quindi, per il primo elemento dell'elenco, abbiamo aggiunto il link come "1. [Introduzione] (#Introduzione)."

Il testo nella staffa quadrata verrà visualizzato così com'è e quando facciamo clic, scorrere verso la parte del documento in cui troverà lo stesso testo di intestazione che abbiamo fornito nelle parentesi rotonde. L'elemento del secondo elenco è aggiunto come “2. [Argomento 1] (#Topic-1)."Qui," Topic 1 "sarà reso così com'è e il"#Topic-1 "sarà incorporato come un link di sezione. L'elemento del terzo elenco ha il testo “3. [Argomento 2] (#Topic-2)."E l'ultimo elemento lo ha come" 4. [Topic 3] (#Topic-3)."

Ora creeremmo sottotitoli con lo stesso titolo indicato nella sezione Elenco Link. Per creare i sottotitoli, dobbiamo usare doppi hash (##). Dopo i simboli, metti uno spazio e quindi iscrivi il titolo di intestazione, che dovrebbe essere lo stesso definito per il collegamento nell'elenco sopra. Se aggiungiamo un titolo diverso, il link non funzionerà. Quindi, abbiamo aggiunto il primo sottotitolo dopo aver inserito gli hash come "Introduzione."Per il secondo, terzo e quarto titoli, i titoli sono rispettivamente" Topic 1 "," Topic 2 "e" Topic 3 ".

La finestra di anteprima ci mostra il risultato previsto corrispondente per questo script di markdown, in cui viene generato una tabella dei contenuti con 4 elementi dell'elenco e le loro intestazioni di riferimento sono state visualizzate sotto di essi.

Tutti questi sono contenuti testuali. Possiamo anche aggiungere un collegamento esterno come intestazione nella tabella del contenuto. Seguiremo lo stesso modello che abbiamo usato nella creazione di elementi dell'elenco precedente, tranne una cosa. Aggiungeremo un link al sito Web con il link sezione anche tra parentesi rotonde. Per questo, abbiamo creato per la prima volta un altro elemento dell'elenco come “5. [Argomento 4] (#Topic-5httpwwyahoocom)."Puoi vedere che non abbiamo aggiunto alcun punto nel nome del sito Web.

Ora dobbiamo creare un'intestazione corrispondente a questo link. Quindi, abbiamo aggiunto doppi hash e spazio, e poi qui non scriveremo semplicemente il testo per il titolo; Invece creeremo un link. Innanzitutto, avremmo scritto il testo del link, che abbiamo inserito lo stesso specificato per la nuova elemento dell'elenco “[Argomento 5]."Quindi abbiamo inserito staffe rotonde immediatamente dopo le parentesi quadrate e abbiamo scritto il collegamento del sito Web completo come" http: // www.Yahoo.com ".

Ciò aggiungerà un'altra intestazione al tavolo dei contenuti, ma è un collegamento, non solo un testo semplice.

Puoi vedere che l'ultima intestazione è stata sottolineata, il che rappresenta indica che è un collegamento. Quando facciamo clic su di esso, aprirà l'indirizzo Web specificato nel browser. Qui abbiamo fornito il "Yahoo.com ". Quindi, aprirà Yahoo nel nostro browser.

Abbiamo generato con successo il nostro contenuto in Markdown, che ha alcuni titoli e un elenco. Ora vedremo come possiamo aggiungere sottotitoli alle intestazioni principali dell'elenco.

Dall'elenco dei contenuti che abbiamo generato in precedenza, abbiamo scelto il 2nd elenco elemento, che ha il titolo "Topic 1". Per creare un elenco di figli, dobbiamo inserire due spazi nella riga accanto all'elemento dell'elenco dei genitori. Dopo aver dato gli spazi, abbiamo numerato l'elenco come "1."Quindi abbiamo usato le staffe quadrate per specificare i titoli, seguiti immediatamente da parentesi rotonde per fornire un collegamento alla parte specifica del documento. Quindi, abbiamo aggiunto due elementi dell'elenco dei figli come “1. [Sub-topic 1] (#sub-topic-1) "e nella riga successiva, il secondo elemento è" 2. [Sub-topic 2] (#sub-topic-2.) "

Quindi, passando alla parte del contenuto del documento, abbiamo aggiunto due nuove sottosegne. Per la creazione di sottotitoli con il livello 3, dobbiamo aggiungere 3 simboli hash (#) seguiti da uno spazio e dal testo della sotto-testa. Abbiamo specificato gli stessi titoli che abbiamo menzionato per collegare le sezioni nell'elenco. Il primo sottotitolo ha il titolo "Sub-topic 1" e il secondo è "Sub-topic 2."

Nell'istantanea della finestra di anteprima in basso, puoi vedere che i sottotitoli sono stati aggiunti correttamente al nostro contenuto di markdown.


Conclusione

Il Sommario (TOC) può essere generato manualmente in un documento di markdown. In questa guida, abbiamo lavorato sulla capacità di Markdown di consentire manualmente la generazione di un contenuto. Abbiamo eseguito i frammenti di codice ed elaborato su tutta la sintassi utilizzata e i passaggi che devono essere eseguiti. Abbiamo imparato a creare un semplice contenuto con un elenco di markdown e intestazioni. Inoltre, incorporare collegamenti esterni nelle intestazioni del documento lo rende completo per te.