ToC oder Sidebar im GitHub Wiki

Wie erstelle ich ein ToC oder ein Seitenleistenmenü in einem GitHub-Wiki?

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

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

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

• https://gist.github.com/379469 - einige 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 auf Ihrer Website nur eingeschränkt webbasiert bearbeiten. ""

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

Ausführliche Anweisungen finden Sie im Menü-Builder der Github Wiki-Seitenleiste mit mehreren Ebenen .

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

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

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

Dieser Prozess ist ein Schmerz im Arsch. Ich bin überrascht, dass dieses "Gollum" -Wiki jede Akzeptanz hat.

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

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

Jetzt haben Sie eine Seite, die Sie wie jede andere Markdown- Seite bearbeiten würden . 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

Beachten Sie, dass es bei der ursprünglichen Frage darum ging, eine Seitenleiste (einfach, in den Antworten gelöst) oder ein tatsächliches Inhaltsverzeichnis (nicht beantwortet) zu erstellen.

Eine Sache, die ich sagen kann, ist, dass die Gollum 2.1-Wiki-Syntax ein [[_TOC_]]Tag zulässt , aber ein GitHub-Wiki erkennt das (noch?) Nicht.

Ich denke, das ist im Gollum beschriebenREADME . (Siehe die Kopf- und Seitenleistenabschnitte.)

Im Wesentlichen erstellen Sie ein _footer.extund _sidebar.extin dem Verzeichnis, das den Seiteninhalt enthält.

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.

Ich habe das npm-Modul github-wiki-sidebar implementiert , um Github-Benutzern das einfache 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

Quellseiten (wie im Wiki-Administrator angezeigt):

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

Ergebnis (mit kundenspezifischer Bestellung):

• Zuhause
• Installation
• Verwendung
  • Init-Modus
  • Befehlszeilenmodifikatoren
• Roadmap

Voraussetzungen:

• Klonen Sie Ihr Github-Wiki-Repository lokal (unten rechts in der Wiki-Benutzeroberfläche angezeigt).

• Installieren Sie die Github-Wiki-Seitenleiste

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

Erstellen / aktualisieren Sie Ihr Wiki-Menü:

• Erstelle neue Seiten / benenne Seiten in deinem github.com-Wiki-Administrator 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 Markdown-Ausgabe, einschließlich der Reihenfolge der Elemente, des Kategorietrennzeichens, der Vorlage für das Menü, des Formats der Links und anderer Elemente.

GitHub generiert automatisch ein Dokumentinhaltsverzeichnis:

1. Machen Sie den Dokumenttyp AsciiDoc anstelle von Markdown.
2. :toc:Am Anfang des Dokuments einfügen .