it-swarm.com.de

ToC oder Sidebar im GitHub Wiki

Wie erstelle ich einen ToC oder ein Sidebar-Menü in einem GitHub-Wiki?

Ich habe einige Erwähnungen gesehen und gollum, das Backend scheint das zu unterstützen, aber wie mache ich das in einem aktuellen GitHub-Projekt?

Es sollte am besten automatisch auf den Überschriften basieren, die ich auf der Seite habe.

Diese Links erwähnen es alle, zeigen aber nicht, wie es geht:

  • https://Gist.github.com/379469 - etwas JavaScript-Hack
  • https://github.com/blog/774-git-powered-wikis-improved - GitHub erwähnt es:

    "GitHub Wikis verfügen über eine wenig dokumentierte Funktion für Fußzeilen und Seitenleisten, mit der einige unserer git-basierten Wiki-Autoren vertraut sind. Mit dem neuen Wiki-Editor können Sie die Fußzeilen und Seitenleisten Ihrer Website nur eingeschränkt webbasiert bearbeiten. "

79
wolle

Okay. Lassen Sie mich sehen, ob ich das richtig verstehe:

  1. Klonen Sie Ihr GitHub-Wiki. (Es gibt einen Git-Bereich im Wiki. Sie können Ihren Wiki-ähnlichen Code auschecken.)
  2. Erstellen _Sidebar.md
  3. Verwenden Sie in normalen Wiki-Seiten [[link]] für die Seitenleiste
  4. Commit und Push zurück zu GitHub

Dieser Prozess ist ein Schmerz im Arsch. Ich bin überrascht, dass dieses "Gollum" -Wiki akzeptiert wird.

auch:_Sidebar.md ist daher global für alle Seiten . Ich müsste mein Wiki in Ordnern organisieren, damit ich verschiedene Seitenleisten für verschiedene Seiten definieren kann.

24
wolle

Während Ihre Lösung funktioniert, gibt es eine einfachere Möglichkeit, dies über die GitHub-Weboberfläche zu tun. Sie können einfach eine Seite mit dem Namen _Sidebar Und/oder _Footer Erstellen.

Detaillierte Anweisungen finden Sie in Github Wiki Sidebar Menu Builder mit mehreren Ebenen.

Bearbeiten Der Originalartikel ist weg und ich kann ihn nicht im Cache finden, also habe ich den Link aktualisiert.

76
nicerobot

Wenn Sie sich im Wiki Ihres Projekts befinden, gibt es einen Link . Fügen Sie eine benutzerdefinierte Seitenleiste hinzu . Klicken Sie darauf.

Enter image description here

Jetzt haben Sie eine Seite, die Sie wie jede andere Seite bearbeiten Abschrift . Um ein Inhaltsverzeichnis zu erstellen, müssen Sie dies jedoch manuell tun. Es gibt keine automatisierte Methode (Stand August 2014). Also zum Beispiel:

# 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

Beachten Sie, dass die ursprüngliche Frage das Erstellen einer Seitenleiste (einfach, in den Antworten gelöst) oder eines tatsächlichen Inhaltsverzeichnisses (nicht beantwortet) betraf.

Eine Sache, die ich sagen kann, ist, dass die Wiki-Syntax von Gollum 2.1 ein [[_TOC_]] tag, aber ein GitHub-Wiki erkennt das (noch?) nicht.

10
mark

Ich denke, das ist im Gollum README beschrieben. (Siehe Kopfzeile und Seitenleiste.)

Im Wesentlichen machen Sie ein _footer.ext und _sidebar.ext in dem Verzeichnis, das den Seiteninhalt enthält.

4
seandavi

Ich habe gerade ein Python Skript erstellt, das einen Index in der _Sidebar.md von GitHub basierend auf der Ordnerstruktur und den Seiten im Wiki-Git generiert.

Enter image description here

3

Ich habe das npm-Modul github-wiki-sidebar implementiert, um github-Benutzern das Erstellen und Verwalten des Sidebar-Menüs zu erleichtern.

Quelle und Ergebnis: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

Quellenseiten (wie im Wiki-Administrator angezeigt):

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

Ergebnis (bei kundenspezifischer Bestellung):

Voraussetzungen:

  • klonen Sie Ihr Github-Wiki-Repository lokal (unten rechts in der Wiki-Benutzeroberfläche angezeigt)
  • installiere die github-wiki-sidebar

    git clone <https://github.com/<username>/<my-project-name>.wiki.git
    npm install -g github-wiki-sidebar
    

Erstelle/aktualisiere dein Wiki-Menü:

  • erstelle neue seiten/benenne seiten in deinem github.com wiki admin um
  • führen Sie lokal das Skript github-wiki-sidebar in Ihrem Wiki-Repository-Ordner aus

    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
    

Das Modul ermöglicht die Anpassung der Abschriftenausgabe, einschließlich der Reihenfolge der Elemente, des Kategorietrennzeichens, der Vorlage für das Menü, des Formats der Links und anderer Elemente.

2
adtanasa