github - paths - markdown table




GitHub relativer Link in Markdown-Datei (6)

Gibt es eine Möglichkeit, einen URL-Anker, <a> , einen Link innerhalb einer Markdown-Datei zu einer anderen Datei im selben Repository und in derselben Verzweigung (auch als Link zum aktuellen Zweig bezeichnet) zu erstellen?

Zum Beispiel habe ich im Master-Zweig eine README.md-Datei, die ich gerne so machen würde:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib documentation
see documentation [here](myLib/README.md)

Dies würde mir erlauben, von einem .md zu einem anderen innerhalb desselben Zweigs zu verbinden und mich nicht darum kümmern zu müssen, in welchem ​​Zweig ich mich befinde (vermeide es, eine absolute URL zu machen, die den github.com-Zweignamen enthält).

Hier ist ein Arbeitsbeispiel von dem, was ich meine:

  1. GOTO http://github.com/rynop/testRel , Link funktioniert nicht.
  2. GOTO http://github.com/rynop/testRel/blob/master/README.md , Link funktioniert.

Dies wird erwartet, da zu diesem Zeitpunkt die Start-URL in der Verzweigung ist. Nun, wie bekomme ich es, um den aktuellen Zweig in der README.md im Stammverzeichnis des Repository abholen?

Update : Ich habe ein issue mit GitHub für diese Feature-Anfrage geöffnet.


Ab dem 31. Januar 2013 unterstützt Github markdown relative Links zu Dateien .

[a relative link](markdown_file.md)

Es gibt jedoch einige Mängel, die in diesem Kommentarthema besprochen wurden .

Alternativ können Sie mit Gitdown vollständige URLs zum Repository Gitdown und diese sogar für Zweigstellen Gitdown , z

{"gitdown": "gitinfo", "name": "url"} // https://github.com/gajus/gitdown
{"gitdown": "gitinfo", "name": "branch"} // master

Gitdown ist ein GitHub Markdown Preprozessor. Es rationalisiert gängige Aufgaben im Zusammenhang mit der Pflege einer Dokumentationsseite für ein GitHub-Repository, z. B. das Generieren von Inhaltsverzeichnissen, einschließlich Variablen, das Generieren von URLs und das Abrufen von Informationen über das Repository selbst zum Zeitpunkt der Verarbeitung der Eingabe. Gitdown fügt sich nahtlos in Ihre Gebäudeskripte ein.

Ich bin der Autor der Gitdown-Bibliothek.


Diese Frage ist ziemlich alt, aber sie scheint immer noch wichtig zu sein, da es nicht einfach ist, relative Verweise von readme.md auf Wiki-Seiten auf Github zu setzen.

Ich habe ein bisschen herumgespielt und dieser relative Link scheint ziemlich gut zu funktionieren:

[Your wiki page](../../wiki/your-wiki-page)

Die beiden ../ entfernen /blob/master/ und verwenden Ihre Basis als Ausgangspunkt. Ich habe dies jedoch nicht auf anderen Repositories als Github versucht (es kann Kompatibilitätsprobleme geben).


Ich bin mir nicht sicher, ob ich diese Option hier sehe. Sie können einfach einen /folder in Ihrem Repository erstellen und direkt verwenden:

[a relative link](/folder/myrelativefile.md)

Kein Blob, kein Baum oder Repository-Name wird benötigt, und es funktioniert wie ein Zauber.


Ich wollte das nur hinzufügen, weil keine der obigen Lösungen funktioniert, wenn der Ziellink ein Verzeichnis mit Leerzeichen in seinem Namen ist. Wenn der Ziel-Link ein Verzeichnis ist und Platz hat, wird der Link auf Github nicht angezeigt, selbst wenn das Leerzeichen nicht mit \ geteilt wird. Die einzige Lösung, die für mich funktioniert, verwendet %20 für jeden Bereich.

zB: wenn Verzeichnisstruktur das ist

Top_dir
|-----README.md
|-----Cur_dir1
      |----Dir A
           |----README.md
      |----Dir B
           |----README.md

Um einen Link zu Dir A in README.md in Top_dir , können Sie Top_dir tun:

[Dir 1](Cur_dir1/Dir%20A)

Update 30. Januar 2013 , 16 Monate später:

GitHub Blog Post Relative Links in Markup-Dateien :

Ab heute unterstützt GitHub relative Links in Markup-Dateien .
Jetzt können Sie direkt zwischen verschiedenen Dokumentationsdateien verknüpfen, unabhängig davon, ob Sie die Dokumentation zu GitHub selbst oder lokal mit einem anderen Markup-Renderer anzeigen.

Sie möchten Beispiele für Link-Definitionen und wie sie funktionieren? Hier ist ein Markdown für dich.
Anstelle eines absoluten Links:

[a link](https://github.com/user/repo/blob/branch/other_file.md)

... können Sie einen relativen Link verwenden:

[a relative link](other_file.md)

und wir werden sicherstellen, dass es mit dem user/repo/blob/branch/other_file.md .

Wenn Sie eine Problemumgehung wie [a workaround link](repo/blob/master/other_file.md) , müssen Sie Ihre Dokumentation aktualisieren, um die neue Syntax zu verwenden.

Dies bedeutet auch, dass Ihre Dokumentation jetzt problemlos eigenständig sein kann, ohne immer auf GitHub zu verweisen .

Update 20. Dezember 2011:

Das GitHub-Markup-Problem 84 wird derzeit von technoweenie mit dem Kommentar geschlossen:

Wir haben versucht, ein <base> -Tag hinzuzufügen, aber es verursacht Probleme mit anderen relativen Links auf der Site.

12. Oktober 2011:

Wenn Sie die README.md Quelle von README.md von Markdown selbst (!) README.md , scheinen relative Pfade nicht unterstützt zu werden.
Sie finden Referenzen wie:

[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13

Wenn Sie einen relativen Link zu Ihrer Wiki-Seite auf GitHub haben möchten, verwenden Sie Folgendes:

Read here: [Some other wiki page](path/to/some-other-wiki-page)

Wenn du einen Link zu einer Datei im Repository haben willst, sagen wir, um eine Header-Datei zu referenzieren und die Wiki-Seite ist die Wurzel des Wikis, benutze dies:

Read here: [myheader.h](../tree/master/path/to/myheader.h)

Der Grund für das letzte ist, den Pfad "/ wiki" mit "../" zu überspringen und zum Master-Zweig in der Repository-Struktur zu gehen, ohne den Repository-Namen anzugeben, der sich in der Zukunft ändern kann.







github-flavored-markdown