Comment puis-je créer une sorte de table des matières dans GitHub wiki?
Si vous regardez ici: http://en.wikipedia.org/wiki/Stack_Overflow
Vous remarquerez qu'il y a un peu de "Contenu", si vous cliquez sur un des liens, il va vous envoyer à une section spécifique sur la page.
Comment puis-je faire dans GitHub wiki? Avec Markdown ou ce qu'ils utilisent?
- Liées, mais pas la copie exacte, qui va plus dans le détail: stackoverflow.com/q/9721944/2291
Vous devez vous connecter pour publier un commentaire.
Il est bien démontré dans la Table des Matières de la Markdown Triche.
Si vous passez la souris sur un en-Tête dans un GitHub Markdown fichier, vous allez voir un petit lien simple vers la gauche, vous pouvez également utiliser ce lien. Le format pour que le lien est
<project URL#<header name>
. Le<header name>
doit être en minuscules.__TOC__
directement. Clairement le sous-jacent autogeneration logique est là. Mais la fonctionnalité ne semble pas être exposés dans leur Markdown style de montage. Tout à fait regrettable. Nous allons tous commencer à envoyer des demandes de fonctionnalités et peut-être qu'ils vais le mettre en marche.#Headers
au lieu de#headers
. Je pensais que c'était une faute de frappe dans votre réponse. Peut-être que vous pouvez ajouter à votre réponse à cette information.[Tailing logs](#tailing-logs)
Un possible (semi-automatique) est la solution de Eugene Kalinine est
github-markdown-toc
. Cet outil essentiellement croque par le biais de votreREADME.md
fichier et snarfs hors#
's des titres pour créer une table des matières.Nourrir votre
README.md
pour le script (comme noté dans sonREADME.md
)cat README.md | bash github-markdown-table des matières
Couper et coller générés de table des matières et le placer en haut de votre
README.md
fichierNoter que cette
bash
application ne fonctionne que sur Linux (à partir de ce que je peux dire).Comme une note de côté, il y a un golang la mise en œuvre et est probablement plus compliqué de se mettre au travail.
https://github.com/jonschlinkert/markdown-toc
git clone your-repo.wiki.git
(ajouter le.wiki
juste avant.git
de cloner le wikinpm i -g markdown-toc
<!-- toc -->
(sensible à la casse) dans votre wiki markdownmarkdown-toc -i my-wiki-markdown.md
(-i
va modifier en place)Mise à jour: je pense que peut-être https://github.com/thlorenz/doctoc est plus populaire aujourd'hui.
Actuellement c'est pas possible de le faire à l'aide de la syntaxe markdown (
.md
). Il est en cours officieux la discussion sur la génération automatique de la table des matières table des matières sur rendu démarque des fichiers commeREADME.md
qui répertorie certaines des idées.Cependant il y a certaines autres solutions comme:
Utilisation
AsciiDoc
plutôt que par les suggestions de ce commentaire. Par exemple:Vérifier l'exemple à
littlebits/réagir-liste
(README.adoc
).En ligne Table De Générateur De Contenu (raychenon/play-table des matières)
Si vous n'êtes pas en position de le coller avec de la Markdown, vous pouvez faire en tant que ci-dessous:
Cependant, l'utilisation de Markdown fichiers dans GitHub/repo, vous pouvez l'obtenir sur GitHub Pages comme dans Wikipédia
Vous pouvez choisir le mode d'Édition "MediaWiki", ce qui va générer une table des matières pour les en-têtes, par exemple
Depuis github ne peut pas utiliser
TOC
directement, mais nous avons d'autres alternatives.Vous pouvez générer automatiquement la table des matières par outil en Ligne:
Générer la table des matières Table des Matières à partir de GitHub Markdown ou un Wiki en Ligne
ou via Locaux de l'outil:
github-markdown-table des matières
Solution la plus simple pour moi (alors que j'ai toujours node.js server est installé et depuis mnp ont npx) est par l'exécution de npx markdown-table des matières. Il semble que c'est l'un des plus populaires de la solution de cette tâche:
de sortie: