1501 Stimmen

GitHub-Relativer Link in Markdown-Datei

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:

  1. GEHE ZU http://github.com/rynop/testRel, Link funktioniert nicht.
  2. 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.

16voto

WesternGun Punkte 9127

Sie können auf Dateien verlinken, aber nicht auf Ordner, und bedenken Sie, dass GitHub /blob/master/ vor Ihren relativen Link hinzufügt (und Ordner diesen Teil nicht enthalten, daher können sie nicht verlinkt werden, weder mit HTML Tags noch mit Markdown-Links).

Also, wenn wir eine Datei in myrepo/src/Test.java haben, wird sie eine URL wie diese haben:

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

Und um sie in der Readme-Datei zu verlinken, können wir verwenden:

[Dies ist ein Link](src/Test.java) 

oder: [Dies ist ein Link](src/Test.java).

(Ich vermute, dass master den master Branch repräsentiert und es sich unterscheidet, wenn die Datei in einem anderen Branch ist.)

13voto

Alex Punkte 1938

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

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

[Deine Wiki-Seite](../../wiki/deine-wiki-seite)

Die beiden ../ werden /blob/master/ entfernen und deine Basis als Ausgangspunkt verwenden. Ich habe dies jedoch noch nicht auf anderen Repositories als Github ausprobiert (es könnten Kompatibilitätsprobleme auftreten).

11voto

Jon Chase Punkte 463

Sie können relative URLs vom Wurzelverzeichnis Ihres Repositories mit verwenden. Angenommen, Ihr Repo heißt testRel, geben Sie Folgendes in testRel/README.md ein:

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

myLib Dokumentation

siehe Dokumentation: * myLib/

9voto

heySushil Punkte 322

In .md Datei, wenn Sie einen Link zu Dateien erstellen möchten, die sich im selben Projektordner befinden oder auf URL basierende Links:

  1. Vorhandener Dateilink:

In .md Datei fügen Sie den Anzeigenamen im [] Feld hinzu, dann öffnen Sie () und fügen / hinzu. Danach werden automatisch alle vorhandenen Ordner abgerufen, aus denen Sie Ihren Ordner auswählen, dann ein '/' hinzufügen, es wird den inneren Datei oder die 'Ordner` anzeigen. Dies bedeutet, dass die Pfade automatisch abgerufen werden und am Ende Ihre URL erstellt wird.

Beispiel:

[Anzeigenamen eingeben](/benutzer/4000266/heysushil)

Diese Zeile sieht so aus: Anzeigenamen eingeben

  1. URLs in .md Datei hinzufügen

Befolgen Sie den gleichen Prozess, ändern Sie nur den Pfad im () Feld mit URL wie folgt:

 [HeySushil - YouTube](https://youtube.com/heysushil)

Dies sieht aus wie HeySushil - YouTube

Hinweis: Denken Sie daran, dass Sie nach dem Hinzufügen von / im () Feld keine erzwungene manuelle Eingabe hinzufügen müssen, es werden automatisch alle vorhandenen Ordner und Dateien abgerufen.

6voto

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

[ein relativer Link] (/ Ordner / myrelativefile.md)

Es ist kein Blob, Baum oder Repositoryname erforderlich, und es funktioniert wie ein Zauber.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X