ToC ou sidebar dans le wiki de Github

Question

Comment puis-je créer une table des matières ou Un menu de barre dans Github Wiki, j'ai vu quelques mentions et gollum le backend semble le soutenir, mais comment puis-je le faire dans un projet github? Elle devrait être fondée sur les en-têtes que j'ai dans la page automatiquement.

Ces liens permettent tous de le mentionner, mais ne montrent pas comment le faire

• https://gist.github.com/379469 - certaines java script de hack

• https://github.com/blog/774-git-powered-wikis-improved - github mentionner:

  "GitHub Wikis sont un peu documentés capacité pour les pieds de page et des barres de navigation, quelque chose que certains d' notre git à base de Wiki auteurs sont familiers avec. Le nouvel éditeur de Wiki vous donne limitée basée sur le web montage des pieds de page et des barres de navigation que vous avez sur votre site. "

Answer 1

Pendant que votre solution fonctionne, il existe un moyen plus simple de le faire en utilisant l'interface Web de Github. Vous pouvez simplement créer une page nommée _Sidebar et / ou _Footer .

Voir les instructions détaillées dans " AJOUTER UNE TABLE DES MATIÈRES À VOTRE GITHUB WIKI ".

Answer 2

Lorsque vous êtes dans le wiki de votre projet, il existe un lien Ajouter une barre latérale personnalisée . Cliquez dessus.

Vous avez maintenant une page que vous éditez comme vous éditeriez une autre page de démarque. Pour créer une table des matières, vous devez le faire manuellement. Il n'y a pas de méthode automatisée (à partir d'août 2014). Donc par exemple:

 # My menu
* [Home][home]
* [Technical documentation][techdocs]
* [User manual][usermanual]

[home]: https://github.com/myproject/wiki/Home
[techdocs]: https://github.com/myproject/wiki/Technical-documentation
[usermanual]: https://github.com/myproject/wiki/User-manual
 

Answer 3

Ok. Permettez-moi de voir si je comprends bien:

1. Cloner votre wiki Github. (Il y a un git section dans le wiki. Vous pouvez payer votre wiki comme le code.)
2. Créer _Sidebar.md
3. Normal pages wiki, utilisez [[link]] de la barre de menu
4. S'engager et à la pousser vers Github

Ce processus est une douleur dans le cul. Je suis surpris de ce "gollum" wiki a toute acceptation.

Aussi: _Sidebar.md est donc global pour toutes les pages. Je dois organiser mon wiki dans des dossiers, afin que je puisse définir les différents encadrés pour les différentes pages.

Answer 4

Notez que la question initiale concernait la création d'une barre latérale (facile, résolue dans les réponses) ou d'une table des matières réelle (sans réponse).

Une chose que je peux dire, c'est que la syntaxe wiki de gollum 2.1 autorise une balise [[_TOC_]] , mais que github wiki ne le reconnaîtra pas (encore?).

Answer 5

Je pense que cela est décrit dans le Gollum README . (Voir les sections d'en-tête et de la barre latérale.)

Essentiellement, vous faites un _footer.ext et _sidebar.ext dans le répertoire contenant le contenu de la page.