Si vous regardez ici : http://en.wikipedia.org/wiki/Stack_Overflow
Vous remarquerez qu'il y a une petite section "Contenu". Si vous cliquez sur l'un des liens, vous serez dirigé vers une section spécifique de la page.
Comment faire dans le wiki de GitHub ? Avec Markdown ou ce qu'ils utilisent ?
La table des matières de l'ouvrage en est une belle démonstration. Feuille de calcul Markdown .
##### Table of Contents
[Headers](#headers)
[Emphasis](#emphasis)
...snip...
<a name="headers"/>
## HeadersSi vous survolez un en-tête dans un fichier Markdown de GitHub, vous verrez un petit échantillon de lien à sa gauche, vous pouvez également utiliser ce lien. Le format de ce lien est le suivant <project URL#<header name> . Le site <header name> doit être tout en minuscules.
Puisque github ne peut pas utiliser TOC directement, mais nous avons d'autres alternatives.
Vous pouvez générer automatiquement la COT via Outil en ligne :
Générer une table des matières à partir de GitHub Markdown ou de Wiki en ligne
ou via Outil local :
Si vous utilisez Code Visual Studio il existe une extension facile à utiliser appelée Markdown tout en un qui peut faire la table des matières de n'importe quel fichier .md en un instant.
Il suffit d'ouvrir la palette de commande ( Ctrl-Shift-P ) -> Markdown: Create Table of Contents
Une autre astuce consiste à désactiver la mise à jour automatique de la table des matières lors de l'enregistrement en utilisant la fonction
"markdown.extension.toc.updateOnSave": false,dans vos paramètres Visual Studio (Palette de commande -> Préférences : Ouvrir les paramètres (JSON)).
Une solution possible (semi-automatisée) est celle d'Eugene Kalinin. github-markdown-toc . Cet outil passe essentiellement en revue vos README.md et sortent le fichier # pour créer une table des matières.
Télécharger le script https://github.com/ekalinin/github-markdown-toc
Nourrissez votre README.md au script (comme indiqué dans l'avis d'Eugène README.md )
cat README.md | bash github-markdown-toc
Coupez et collez la table des matières générée et placez-la en haut de votre page d'accueil. README.md fichier
Notez que cette bash L'implémentation ne fonctionne que sur Linux (d'après ce que je peux dire).
À titre d'information, il existe une version de golang mise en œuvre et est probablement plus difficile à faire fonctionner.
Mise à jour août 2021 :
Après le ToC dans le README (voir Mars 2021 ci-dessous), vous avez maintenant :
Table des matières pour les Wikis
Pour les wikis, nous générons désormais automatiquement une table des matières basée sur les titres Markdown.
Comme illustré ici :
Vous faites du wiki ?
Nous venons d'ajouter une table des matières automatique dans la barre latérale pour faciliter la navigation.
Vous pouvez dès à présent (mars 2021) découvrir ce que le PDG de GitHub, Nat Friedman, a fait pour vous. vient d'annoncer
GitHub crée maintenant automatiquement une table des matières pour votre site web. http://README.md à partir de vos en-têtes.
Après mûre réflexion, nous avons fait en sorte que ce soit une fonctionnalité de la visionneuse, et non une préoccupation de l'éditeur : il n'y a pas de balisage spécial à insérer.
Donc... il ne modifie pas votre markdown ( README.md ou autre .md ) pour insérer, ou mettre à jour votre texte : il fournit seulement un menu qui permet un accès rapide à vos sections de test basées sur les en-têtes markdown.
C'est peut-être, ou peut-être pas, ce que vous recherchez.
Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.
