it-swarm.com.de

Wie erstelle ich eine Art Inhaltsverzeichnis im GitHub-Wiki?

Wenn Sie hier suchen: http://en.wikipedia.org/wiki/Stack_Overflow

Sie werden feststellen, dass es einen kleinen Bereich "Inhalt" gibt. Wenn Sie auf einen der Links klicken, werden Sie zu einem bestimmten Bereich auf der Seite weitergeleitet.

Wie mache ich das im GitHub-Wiki? Mit Markdown oder was auch immer sie verwenden?

45
Evan

Dies wird im Inhaltsverzeichnis des Markdown-Cheatsheets gut demonstriert.

##### Table of Contents  
[Headers](#headers)  
[Emphasis](#emphasis)  
...snip...    
<a name="headers"/>
## Headers

Wenn Sie sich in einer GitHub Markdown-Datei über einem Header befinden, wird links ein einfacher Link angezeigt. Sie können diesen Link auch verwenden. Das Format für diesen Link lautet <project URL#<header name>. Der <header name> muss nur aus Kleinbuchstaben bestehen.

59
RyPeck

Eine mögliche (halbautomatisierte) Lösung ist Eugene Kalinins github-markdown-toc. Dieses Tool durchläuft im Wesentlichen Ihre README.md-Datei und erstellt die Überschriften von #, um ein Inhaltsverzeichnis zu erstellen.

  1. Laden Sie das Skript herunter https://github.com/ekalinin/github-markdown-toc
  2. Füttern Sie Ihr README.md mit dem Skript (wie in Eugene's README.md angegeben)

    cat README.md | bash github-markdown-toc

  3. Schneiden Sie das generierte Inhaltsverzeichnis aus und fügen Sie es ein. Platzieren Sie es oben in Ihrer README.md-Datei

Beachten Sie, dass diese bash-Implementierung nur unter Linux funktioniert (was ich sagen kann).

Als Randbemerkung gibt es eine Golang Implementierung und ist wahrscheinlich eher mühselig, um zu arbeiten.

11
John Tran

https://github.com/jonschlinkert/markdown-toc

  • git clone your-repo.wiki.git (fügen Sie den .wiki direkt vor .git hinzu, um das Wiki zu klonen
  • npm i -g markdown-toc
  • Fügen Sie <!-- toc --> (Groß- und Kleinschreibung beachten) in den Markdown Ihres Wikis ein
  • markdown-toc -i my-wiki-markdown.md (-i wird es an Ort und Stelle bearbeiten)
  • Profitieren

Update: Ich denke, dass https://github.com/thlorenz/doctoc jetzt beliebter ist.

9
corysimmons

Derzeit ist es nicht möglich , dies mit der Markdown-Syntax (.md) auszuführen. Inoffizielle Diskussionen über das automatische Generieren des Inhaltsverzeichnisses TOC für gerenderte Markdown-Dateien wie README.md, in dem einige Ideen aufgelistet sind, sind in der Diskussion.

Es gibt jedoch einige andere Problemumgehungen wie:

7
kenorb

Sie können den Bearbeitungsmodus "MediaWiki" auswählen, der einen Token für die Header generiert, z.

== First ==

== Second ==
2
Stefan

Wenn Sie nicht in der Lage sind, bei Markdown zu bleiben, können Sie Folgendes tun: 

  • on GitHub/wiki: Wechseln Sie Markdown zu MediaWiki . Verwenden Sie __TOC__ Syntak. Siehe sample
  • on GitHub/repo: Wechseln Sie Markdown zu AsciiDoc . Verwenden Sie :toc: Syntak. Siehe Demo .

Wenn Sie Markdown -Dateien in einem Repo verwenden, können Sie es unter GitHub Pages as Jekyll verwendet Kramdown von) verwenden default , wird bereits mit Table Of Content geliefert, der automatisch generiert wird wie in Wikipedia :

Verwenden Sie {:toc} Syntak. Siehe die Erklärung .

2
Chetabahana

Da github TOC nicht direkt verwenden kann, haben wir andere Alternativen.

Sie können das Inhaltsverzeichnis automatisch mit dem Online-Tool erstellen:

Inhaltsverzeichnis von GitHub Markdown oder Wiki Online erzeugen

 enter image description here

oder über Local-Tool:

github-markdown-toc

0
Bravo Yeung

Die einfachste Lösung für mich (während ich node.js Server immer installiert habe und seit npm npx hat) ist das Ausführen von npx markdown-toc . Es scheint, dass es eine der beliebtesten Lösungen für diese Aufgabe ist:

ls
cat <<EOF >> test.md | tee 
## Table of Contents

<!-- toc -->
- old toc 1
- old toc 2
- old toc 3
<!-- tocstop -->

## abc
This is a b c.

## xyz
This is x y z.
EOF
ls
cat test.md
npx markdown-toc -i test.md
cat test.md

ausgabe:

 enter image description here

0
stopsopa