web-dev-qa-db-fra.com

ToC ou Sidebar dans GitHub Wiki

Comment créer un ToC ou un menu de barre latérale dans un wiki GitHub?

J'en ai vu quelques mentions et gollum le backend semble le supporter, mais comment le faire dans un projet GitHub en cours?

Il doit être basé sur les en-têtes que j'ai automatiquement dans la page.

Ces liens le mentionnent tous, mais ne montrent pas comment le faire:

  • https://Gist.github.com/379469 - certains hack JavaScript

  • https://github.com/blog/774-git-powered-wikis-improved - GitHub le mentionnant:

    "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. Le nouvel éditeur Wiki vous offre une édition Web limitée des pieds de page et des barres latérales que vous avez sur votre site. "

githubwiki
79
wolle

D'accord. Voyons si je comprends bien:

  1. Clonez votre wiki GitHub. (Il y a une section Git dans le wiki. Vous pouvez vérifier votre code de type wiki.)
  2. Créer _Sidebar.md
  3. Dans les pages wiki normales, utilisez [[link]] pour la barre latérale
  4. Valider et repousser vers GitHub

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

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

24
wolle

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 Générateur de menu de la barre latérale Github Wiki avec plusieurs niveaux.

Modifier L'article d'origine a disparu et je ne le trouve pas dans le cache, j'ai donc mis à jour le lien.

76
nicerobot

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

Enter image description here

Vous avez maintenant une page que vous modifiez comme vous le feriez pour toute autre page Markdown . Pour faire une table des matières, vous devez cependant le faire manuellement. Il n'y a pas de méthode automatisée (en août 2014). Ainsi, 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
22
Pithikos

Notez que la question d'origine portait sur la création d'une barre latérale (facile, résolue dans les réponses) ou d'une véritable table des matières (sans réponse).

Une chose que je peux dire, c'est que la syntaxe wiki de gollum 2.1 permet un [[_TOC_]] tag, mais un wiki GitHub ne le reconnaîtra pas (encore?).

10
mark

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

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

4
seandavi

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

Enter image description here

3
Christopher Mueller

J'ai implémenté le module npm github-wiki-sidebar pour aider les utilisateurs de github à créer et maintenir 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 (comme affiché dans l'admin Wiki):

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

Résultat (avec commande personnalisée):

Pré-requis:

  • cloner votre dépôt wiki github localement (affiché en bas à droite de l'interface utilisateur Wiki)

  • installez la barre latérale github-wiki

    git clone <https://github.com/<username>/<my-project-name>.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 wiki github.com

  • exécuter localement le script github-wiki-sidebar dans votre dossier de dépôt wiki

    cd /path/to/<my-project-name>.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émarque, y compris la commande des éléments, le séparateur de catégorie, le modèle pour le menu, le format des liens et autres.

2
adtanasa