ToC ou Sidebar dans GitHub Wiki

Comment créer un menu ou une barre de menu dans un wiki GitHub?

J’ai vu quelques mentions et gollum le backend semble le supporter, mais comment puis-je le faire dans un projet GitHub actuel?

Le mieux devrait être basé sur les en-têtes que j’ai dans la page automatiquement.

Tous ces liens le mentionnent, mais ne montrent pas comment le faire:

  • https://gist.github.com/379469 – du piratage de JavaScript
  • https://github.com/blog/774-git-powered-wikis-improved – GitHub en fait mention:

    “Les Wikis GitHub ont une capacité peu documentée pour les pieds de page et les barres latérales, ce que certains de nos auteurs Wiki basés sur git connaissent bien. ”

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 .

D’accord. Laissez-moi voir si je comprends bien:

  1. Clone ton wiki GitHub. (Il y a une section Git dans le wiki. Vous pouvez extraire votre code de type wiki.)
  2. Créer _Sidebar.md
  3. Dans les pages wiki normales, utilisez [[link]] pour la barre latérale
  4. S’engager et repasser à GitHub

Ce processus est une douleur dans le cul. Je suis surpris que le wiki «gollum» soit accepté.

Aussi: _Sidebar.md est donc global pour toutes les pages . Je devrais organiser mon wiki en dossiers pour pouvoir définir différentes barres latérales pour différentes pages.

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

Entrez la description de l'image ici

Vous avez maintenant une page que vous modifiez comme vous modifiez toute autre page de Markdown . Pour créer une table des matières, vous devez le faire manuellement. Il n’y a pas de méthode automatisée (en 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 

Notez que la question initiale était de créer une barre latérale (facile, résolue dans les réponses) ou 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 un wiki GitHub ne le reconnaîtra pas (encore?).

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

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

Je viens de créer un script Python qui génère un index dans le _Sidebar.md de GitHub basé sur la structure des dossiers et les pages du wiki git.

Entrez la description de l'image ici

J’ai implémenté le module npm github-wiki-sidebar pour aider les utilisateurs de github à créer et à gérer facilement le menu de la barre latérale.

Source et résultat: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Pages source (affichées dans Wiki admin):

 Home Installation Roadmap Usage Usage: Command line modifiers Usage: Init Mode 

Résultat (avec commande personnalisée):

  • Accueil
  • Installation
  • Usage
    • Mode init
    • Modificateurs de ligne de commande
  • Feuille de route

Pré-requirejs:

  • clonez votre repository github wiki localement (affiché en bas à droite de l’interface utilisateur du wiki)
  • installer la github-wiki-sidebar

     git clone /.wiki.git npm install -g github-wiki-sidebar 

Créez / mettez à jour votre menu wiki:

  • créer de nouvelles pages / renommer des pages sur votre administrateur github.com wiki
  • exécuter localement le script github-wiki-sidebar dans votre dossier de référentiel wiki

     cd /path/to/.wiki # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github github-wiki-sidebar --git-push 

Le module permet la personnalisation de la sortie de démarquage, y compris l’ordre des articles, le séparateur de catégories, le modèle pour le menu, le format des liens et autres.