GitHub relativer Link in der Markdown-Datei

Gibt es eine Möglichkeit, einen URL-Anker zu erstellen <a>, der aus einer Markdown-Datei mit einer anderen Datei innerhalb desselben Repositorys und Zweigs verknüpft ist (auch bekannt als Link relativ zum aktuellen Zweig)?

Zum Beispiel habe ich im Hauptzweig eine README.md-Datei, die ich gerne machen würde wie:

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

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

Auf diese Weise kann ich innerhalb desselben Zweigs einen Link von einem .md zu einem anderen erstellen und muss mir keine Gedanken darüber machen, in welchem ​​Zweig ich mich befinde (ich muss keine absolute URL erstellen, die den Namen des Zweigs github.com enthält).

Hier ist ein funktionierendes Beispiel dafür, 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 sich zu diesem Zeitpunkt die Start-URL in der Verzweigung befindet. Wie kann ich nun den aktuellen Zweig in der Datei README.md im Stammverzeichnis des Repositorys abrufen?

Update : Ich habe ein Problem mit GitHub für diese Funktionsanforderung geöffnet .

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 auf GitHub selbst oder lokal mit einem anderen Markup-Renderer anzeigen.

Sie möchten Beispiele für Linkdefinitionen und deren Funktionsweise? Hier ist ein Markdown für Sie.
Anstelle eines absoluten Links:

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

… Sie können einen relativen Link verwenden:

[a relative link](other_file.md)

und wir werden sicherstellen, dass es verknüpft wird user/repo/blob/branch/other_file.md.

Wenn Sie eine Problemumgehung wie verwendet haben [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 für sich allein stehen kann, ohne immer auf GitHub zu verweisen .

Update 20. Dezember 2011:

Die GitHub-Markup-Ausgabe 84 wird derzeit von technoweenie mit dem Kommentar geschlossen:

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

12. Oktober 2011:

Wenn Sie sich die RohquelleREADME.md von Markdown selbst (!) Betrachten, 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

Zum Beispiel haben Sie ein Repo wie das folgende:

project/
    text.md
    subpro/
       subtext.md
       subsubpro/
           subsubtext.md
       subsubpro2/
           subsubtext2.md

Der relative Link zu subtext.mdin text.mdkönnte folgendermaßen aussehen:

[this subtext](subpro/subtext.md)

Der relative Link zu subsubtext.mdin text.mdkönnte folgendermaßen aussehen:

[this subsubtext](subpro/subsubpro/subsubtext.md)

Der relative Link zu subtext.mdin subsubtext.mdkönnte folgendermaßen aussehen:

[this subtext](../subtext.md)

Der relative Link zu subsubtext2.mdin subsubtext.mdkönnte folgendermaßen aussehen:

[this subsubtext2](../subsubpro2/subsubtext2.md)

Der relative Link zu text.mdin subsubtext.mdkönnte folgendermaßen aussehen:

[this text](../../text.md)

Zum 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 Kommentarthread erörtert wurden .

Alternativ können Sie Gitdown verwenden , um vollständige URLs zum Repository zu erstellen und diese sogar verzweigungsbewusst zu machen, z

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

Gitdown ist ein GitHub-Markdown-Präprozessor. Es optimiert allgemeine Aufgaben im Zusammenhang mit der Verwaltung 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 lässt sich nahtlos in Ihre Build-Skripte integrieren.

Ich bin der Autor der Gitdown-Bibliothek.

GitHub könnte dies mit minimalem Aufwand viel besser machen. Hier ist eine Umgehung.

Ich denke du willst so etwas mehr

[Your Title](your-project-name/tree/master/your-subfolder)

oder um auf die README selbst zu verweisen

[README](your-project-name/blob/master/your-subfolder/README.md)

Viel Glück

Ich wollte dies nur hinzufügen, da keine der oben genannten Lösungen funktioniert, wenn der Ziellink ein Verzeichnis mit Leerzeichen im Namen ist. Wenn der Ziellink ein Verzeichnis ist und Speicherplatz hat, wird der Link auf Github nicht gerendert, selbst wenn der Speicherplatz mit \ leer ist. Die einzige Lösung, die für mich funktioniert hat, ist die Verwendung%20 für jeden Raum.

zB: wenn dies die Verzeichnisstruktur ist

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

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

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

Sie können eine Verknüpfung zu einer Datei herstellen, jedoch nicht zu Ordnern. Beachten Sie jedoch, dass Github diese /blob/master/vor Ihrer relativen Verknüpfung hinzufügt (und Ordnern fehlt dieser Teil, sodass sie weder mit HTML verknüpft werden können<a> Tags noch mit Markdown-Link verknüpft werden können).

Wenn wir also eine Datei haben myrepo/src/Test.java, hat sie eine URL wie:

https://github.com/WesternGun/myrepo/blob/master/src/Test.java

Und um es in der Readme-Datei zu verknüpfen, können wir verwenden:

[This is a link](src/Test.java)

oder: <a href="src/Test.java">This is a link</a> .

(Ich denke, masterstellt den masterZweig dar und es unterscheidet sich, wenn sich die Datei in einem anderen Zweig befindet.)

Sie können relative URLs aus dem Stammverzeichnis Ihres Repos mit verwenden <a href="">. Angenommen, Ihr Repo heißt testRel, geben Sie Folgendes ein testRel/README.md:

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

## myLib docs
see documentation:
    * <a href="testRel/myLib">myLib/</a>
    * <a href="testRel/myLib/README.md">myLib/README.md</a>

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 in anderen Repositorys als Github versucht (möglicherweise gibt es Kompatibilitätsprobleme).

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

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

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

Wenn Sie einen relativen Link zu Ihrer Wiki-Seite auf GitHub wünschen, verwenden Sie Folgendes:

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

Wenn Sie einen Link zu einer Datei im Repository wünschen, um auf eine Header-Datei zu verweisen, und die Wiki-Seite sich im Stammverzeichnis des Wikis befindet, verwenden Sie Folgendes:

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

Der Grund für den letzten besteht darin, den Pfad "/ wiki" mit "../" zu überspringen und zum Hauptzweig im Repository-Baum zu wechseln, ohne den Repository-Namen anzugeben, der sich in Zukunft möglicherweise ändern wird.