Comment créer une sorte de table des matières dans le wiki GitHub ?

Question

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 ?

Answer 1

Pandoc est le couteau suisse du balisage. Il peut ajouter une table des matières compatible avec GitHub à un fichier markdown appelé README.md avec cette commande :

pandoc --from markdown --to markdown --table-of-contents --standalone  README.md

El --from y --to sont nécessaires, et --table-of-contents nécessite --standalone . Les options ont des versions courtes, donc c'est équivalent :

pandoc -f markdown -t markdown --toc -s README.md

Par défaut, la commande précède la table des matières et écrit le résultat sur stdout. Puisque vous ne voulez probablement que la table des matières elle-même, vous pouvez utiliser un pipe vers un pager pour voir le haut du fichier. Par exemple :

pandoc -f markdown -t markdown --toc -s README.md | less

Les autres options utiles sont les suivantes :

• --toc-depth=NUMBER pour spécifier les niveaux d'en-tête à inclure. La valeur par défaut est 3.
• --output=FILE pour écrire dans un fichier au lieu de stdout.

Ver https://pandoc.org pour l'installation et d'autres instructions d'utilisation.

Answer 2

Vous pouvez utiliser mdtoc (Je suis l'auteur).

Une fois installé, il suffit de l'exécuter :

mdtoc path/to/file.md

Answer 3

Un autre outil de marquage de la table des matières implémenté au dessus de Perl (qui est toujours livré avec Linux/Git-for-Windows et avec Cygwin en option, et il n'y a pas de dépendances sur des paquets supplémentaires).

https://github.com/ildar-shaimordanov/git-markdown-toc

Je suppose que mon outil fonctionne de manière similaire ou presque similaire à ekalinin/git-markdown-toc mentionné ci-dessus par d'autres personnes. Je ne les ai jamais comparés car son outil est implémenté en Go-Lang qui n'existe pas sur mon système. Le but principal de mon script est de fournir une bonne solution pour créer la TOC localement -- pas de connexion à des hôtes externes et ainsi de suite, seulement lire un fichier local (README.md, par défaut) et créer la TOC et l'intégrer au fichier.

Answer 4

Exemple :

[Go to Delete](#delete_lines)

#delete_lines

code here, will be pointed here

Voir : https://guides.github.com/features/mastering-markdown/

Et, pour faire un contour imbriqué :

* 1\. [Go to Delete](#delete_lines)
    * 1.1\. item
    * 1.2\. item
        * 1.2\. item
* 2\. item 

Voir : https://meta.stackexchange.com/questions/85474/how-to-write-nested-numbered-lists

Et pour plus d'informations et des liens complexes :

https://stackoverflow.com/questions/6695439/how-to-link-to-a-named-anchor-in-multimarkdown#:~:text=En%20standard%20Markdown%2C%20place%20an,%5Blink%20text%5D(%23abcd)%20 .