Tableau de contenu Markdown

Tableau de contenu Markdown
Une table des matières est une liste de titres pour les chapitres ou sections d'un document, organisé en fonction de leur séquence d'apparence. Dans Markdown, vous pouvez soit créer une table des matières manuellement, soit en générer un automatiquement. Pour cette leçon, nous pratiquerons la construction de TOC Markdown en utilisant manuellement la syntaxe de script natif Markdown.

Création de table des matières dans Markdown:

Un tableau de contenu peut être créé dans un document en utilisant la syntaxe de Markdown native. Ce tutoriel nous aidera à apprendre la génération de la table de contenu Markdown.

Pour la mise en œuvre pratique des scripts Markdown, nous avons besoin d'un outil qui prend en charge la langue de Markdown. Nous avons choisi le code Visual Studio pour la compilation d'exemples de codes. Après avoir lancé l'outil, nous avons créé un nouveau fichier et défini son type sur «Markdown."Pour ouvrir la fenêtre d'aperçu, il suffit de frapper les touches" Ctrl + Shift + V ". Nous avons maintenant un fichier «Markdown» et une fenêtre d'aperçu qui y correspondait.

L'outil de compilation du script est défini maintenant. La création du tableau du contenu commencerait par la suite. Dans le fichier Markdown, nous avons d'abord créé un en-tête. Pour la création d'un en-tête, nous devons ajouter un symbole de hachage (#). L'ajout d'un seul hachage (#) fait référence au premier niveau. Après le symbole de hachage, un espace doit être donné avant d'écrire le texte de votre en-tête. Le texte que nous avons spécifié pour l'en-tête de notre document est «Table des matières."Cela créera une rubrique avec une taille H1 en haut de notre page Web.

Ensuite, nous avons sauté quelques lignes avant d'écrire le script suivant. Nous allons maintenant créer une liste des en-têtes de contenu disponibles dans le document. Pour créer une liste de démarrage, nous avons deux choix: s'il faut créer des listes commandées ou des listes non ordonnées. Pour la génération de liste, nous devons écrire une valeur numérique et ajouter un point (.) immédiatement après. Ensuite, après un espace, mentionnez les éléments de la liste. Pour les éléments de la liste ici, nous devons créer des liens Markdown qui nous dirigeront vers une section spécifique du document lorsque nous cliquez sur eux.

Nous avons donc ajouté le premier élément de liste avec la valeur numérique «1», puis pour créer le lien vers une section de la page, nous avons d'abord écrit le titre de tête entre les crochets suivis d'un orthèse ronde qui contiendra un hachage (#) symbole et le titre de la tête vers laquelle il peut diriger l'utilisateur. Vous ne pouvez pas donner d'onglet ou d'espace dans les accolades rondes lorsque vous ajoutez des liens à une partie du document. Au lieu de cela, vous pouvez utiliser des tirets (-) partout où il est nécessaire en remplacement des espaces. Ainsi, pour le premier élément de liste, nous avons ajouté le lien comme «1. [Introduction] (# Introduction)."

Le texte de la tranche carrée sera affiché tel quel et lorsque nous cliquez dessus, il fait défiler la partie du document où il trouvera le même texte de cap que nous avons fourni dans les accolades rondes. Le deuxième élément de liste est ajouté comme «2. [Sujet 1] (# Topic-1)."Ici," Topic 1 "sera rendu tel quel et le" # Topic-1 "sera intégré en tant que lien de section. Le troisième élément de la liste a le texte «3. [Sujet 2] (# Topic-2).»Et le dernier élément l'a comme« 4. [Sujet 3] (# Topic-3)."

Maintenant, nous créons des sous-titres avec le même titre que celle mentionnée dans le lien de la section liste. Pour créer les sous-titres, nous devons utiliser des hachages doubles (##). Après les symboles, mettez un espace puis inscrivez le titre de cap, qui devrait être le même que celui défini pour le lien dans la liste ci-dessus. Si nous ajoutons un titre différent, le lien ne fonctionnera pas. Nous avons donc ajouté la première sous-position après avoir inséré les hachages comme «Introduction.«Pour les deuxième, troisième et quatrième titres, les titres sont« Sujet 1 »,« Topic 2 »et« Topic 3 »respectivement.

La fenêtre d'aperçu nous montre le résultat prévu correspondant pour ce script de démarrage, où une table des matières est générée avec 4 éléments de la liste et leurs en-têtes de référence ont été affichés en dessous d'eux.

Tous ce sont des contenus textuels. Nous pouvons également ajouter un lien externe comme une rubrique dans le tableau du contenu. Nous suivrons le même modèle que nous avons utilisé dans la création de la liste précédente, sauf pour une chose. Nous ajouterons également un lien au site Web avec le lien de section dans les crochets ronds. Pour cela, nous avons d'abord créé un autre élément de liste comme «5. [Sujet 4] (# Topic-5httpwwwyahoocom)."Vous pouvez voir que nous n'avons pas ajouté de points dans le nom du site Web.

Nous devons maintenant créer un titre correspondant à ce lien. Nous avons donc ajouté des hachages et de l'espace doubles, puis ici, nous n'écrirons pas simplement le texte pour le titre; Au lieu de cela, nous créerons un lien. Tout d'abord, nous rédigerions le texte du lien, que nous avons inséré de la même manière que celle spécifiée pour le nouvel élément de la liste «[Sujet 5]."Ensuite, nous avons inséré des supports ronds immédiatement après les parenthèses carrées et rédigé le lien complet du site Web comme« http: // www.yahoo.com ».

Cela ajoutera une autre rubrique à la table des matières, mais c'est un lien, pas seulement un texte brut.

Vous pouvez voir que le dernier titre a été souligné, ce qui représente indique qu'il s'agit d'un lien. Lorsque nous cliquez dessus, il ouvrira l'adresse Web spécifiée dans le navigateur. Ici, nous avons fourni le «Yahoo.com ». Alors, ça ouvrira Yahoo dans notre navigateur.

Nous avons réussi à générer notre table des matières dans Markdown, qui a des titres et une liste dedans. Nous allons maintenant voir comment nous pouvons ajouter des sous-titres aux titres principaux de la liste.

À partir de la liste de contenu que nous avons générée précédemment, nous avons choisi le 2nd Élément de liste, qui a le titre «Topic 1». Pour créer une liste d'enfants, nous devons saisir deux espaces dans la ligne à côté de l'élément de liste des parents. Après avoir donné les espaces, nous avons numéroté la liste comme «1."Ensuite, nous avons utilisé les crochets pour spécifier les titres, suivis immédiatement par des supports ronds pour fournir un lien vers la partie spécifique du document. Nous avons donc ajouté deux éléments de liste d'enfants comme «1. [Sous-topic 1] (# sub-topic-1) »et dans la ligne suivante, le deuxième élément est« 2. [Sub-Topic 2] (# sub-topic-2.) "

Ensuite, passant à la partie du contenu du document, nous avons ajouté deux nouveaux sous-titres. Pour créer des sous-titres avec le niveau 3, nous devons ajouter 3 symboles de hachage (#) suivis d'un espace et du texte de la sous-tête. Nous avons spécifié les mêmes titres que nous avons mentionnés pour lier les sections dans la liste. La première sous-tête a le titre «Sub-Topic 1» et le second est «Sub-Topic 2."

Dans l'instantané de la fenêtre d'aperçu ci-dessous, vous pouvez voir que les sous-titres ont été annexés avec succès à notre table des matières de Markdown.


Conclusion

La table des matières (TOC) peut être générée manuellement dans un document de démarrage. Dans ce guide, nous avons travaillé sur la capacité de Markdown de permettre manuellement la génération d'une table des matières. Nous avons exécuté les extraits de code et élaboré sur toute la syntaxe utilisée et les étapes qui doivent être effectuées. Nous avons appris à faire une table des matières simples avec une liste et des titres de marque. De plus, l'intégration des liens externes dans les titres du document le rend complet pour vous.