GitHub-Relativer Link in Markdown-Datei

Question

Gibt es einen Weg, um einen URL-Anker, , Link von innerhalb einer Markdown-Datei zu einem anderen File im selben Repository und Branch (auch bekannt als ein Link relativ zum aktuellen Branch) zu erstellen?

Zum Beispiel habe ich im master-Branch eine README.md Datei, in der ich gerne etwas Ähnliches wie Folgendes machen würde:

# Mein Projekt
ist wirklich sehr cool. Mein Projekt hat ein Unterverzeichnis namens myLib, siehe unten.

## myLib Dokumentation
siehe Dokumentation [hier](myLib/README.md)

Dies würde es mir ermöglichen, von einer .md-Datei zu einer anderen im selben Branch zu verlinken und mir keine Gedanken darüber zu machen, in welchem Branch ich mich befinde (um einen absoluten URL zu vermeiden, der den github.com Branchnamen enthält).

Hier ist ein funktionierendes Beispiel, was ich meine:

2. GEHE ZU http://github.com/rynop/testRel, Link funktioniert nicht.
3. GEHE ZU http://github.com/rynop/testRel/blob/master/README.md, Link funktioniert.

Dies ist zu erwarten, weil zu diesem Zeitpunkt die Ausgangs-URL im Branch ist. Wie bekomme ich also den aktuellen Branch in der README.md am Root des Repositories dazu, aufgenommen zu werden?

Aktualisierung: Ich habe ein Problem auf GitHub für diesen Feature-Request eröffnet.

Answer 1

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

Hier lesen: [Eine andere Wiki-Seite](Pfad/zur/einigen-anderen-wiki-seite)

Wenn Sie einen Link zu einer Datei im Repository möchten, sagen wir, um eine Header-Datei zu referenzieren, und die Wiki-Seite sich im Stammverzeichnis des Wikis befindet, verwenden Sie dies:

Hier lesen: [meinheader.h](../tree/master/Pfad/zur/meinheader.h)

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

Answer 2

Das Verhalten von Github-Verzeichnislinks in Markdown-Dateien kann einige Kopfschmerzen verursachen.

Alle Dateien haben eine URL, die mit "blob" beginnt,

blob///

während Verzeichnisse eine URL haben, die mit "tree" beginnt:

tree//

Also sollte kein relativer Link zu einem Verzeichnis funktionieren. Er zeigt auf eine URL, die mit einem blob beginnt. Magischerweise ändert Github automatisch einige relative Pfade in den tree-Pfad. Leider funktionieren URLs, die ".." enthalten, nicht.

Ich habe einige Zeit damit verbracht, das seltsame Verhalten von Github-Verzeichnislinks auf https://github.com/fluentcodes/GitSamples-GIT/tree/github-readme-links zu untersuchen.

Answer 3

Einfach dem folgenden Format folgen.

[TEXT ZUM ANZEIGEN](tatsächliche URL zum Navigieren)

Answer 4

Sie können auch Ihre Links (relativ oder absolut) am unteren Rand einfügen, um Unordnung im Text zu reduzieren.
Es kann auch eine gute Option für wiederkehrende Links sein.

Dies ist [mein verknüpfter Text].

  [mein verknüpfter Text]: relativer/pfad/in/repo/zur/datei.txt "Optionaler Titel für Maus-Hover"

Dies ist mein verknüpfter Text.