Github-Link zur Wiki-Seite von README

88

Wie erstelle ich einen Link von einer README.md-Datei zu einer Wiki-Seite in Github? Jedes Beispiel scheint eine Verknüpfung von einer Wiki-Seite zu einer anderen Wiki-Seite oder von einer README-Datei zu einer anderen Datei im Repository zu zeigen. Aber keine, die eine Verknüpfung von einem zum anderen zeigen

github

— veilig
quelle

Du hast recht. "von einer README-Datei zu einer anderen Datei im Repository" funktioniert, offizielle Referenz help.github.com/articles/relative-links-in-readmes offizieller Blog github.com/blog/1395-relative-links-in-markup- Dateien , siehe auch bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Aufschlussreich, warum ein Link von README zu Wiki nicht so wünschenswert ist: "Sicher, Sie könnten einen Link zu Ihrem Wiki erstellen - aber das Wiki wird nicht zusammen mit dem Quellcode versioniert, und Sie möchten einen Link zu der Version der dazugehörigen Dokumente erstellen Der genaue Schnappschuss des Quell-Repos, das Sie sich ansehen. Sicher, Sie könnten eine Verknüpfung mit absoluten URL-Hyperlinks herstellen - aber das gleiche Problem, Sie verlinken immer zum Master, wenn Sie im selben Schnappschuss wie der Reader eine Verknüpfung zu der Datei herstellen möchten schaut sich die README in an. " Quelle: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

66

Sie müssten eine absolute URL im Gegensatz zu einer relativen verwenden.

Beispielsweise:

[Sites Using React](https://github.com/facebook/react/wiki/Sites-Using-React)

— maxdeviant
quelle

4

ok, das dachte ich mir - wollte nur sicherstellen, dass es keinen besseren Weg gibt.

— Schleier

2

In dem von @ jmar777 verlinkten Dokument wird vor der Verwendung absoluter URLs gewarnt: "Benutzer, die Ihr Repository klonen, haben es viel schwerer, die Links zum Laufen zu bringen als erwartet."

— Dave Sexton

@ DaveSexton Dies bezieht sich speziell auf die Verknüpfung mit anderen Dateien im Repository (die immer relativ zur README-Datei sind). Wenn Sie auf etwas Externes (wie ein Wiki) verlinken, möchten Sie absolute URLs verwenden.

— Maxdeviant

92

Ich bin gerade auf diese Frage gestoßen und habe gesehen, dass dies unmöglich ist, habe es aber trotzdem hartnäckig versucht. Gute Nachrichten, denn dies kann tatsächlich mit relativen Links erfolgen!

Wenn Sie sich die Dokumentation für relative Links auf GitHub ansehen, können Sie sehen, dass es unterstützt ./und ../operiert.

Vorausgesetzt, Ihre README befindet sich unter:

https://github.com/<user-name>/<repo-name>/blob/master/README.md

... und das Wiki befindet sich unter:

https://github.com/<user-name>/<repo-name>/wiki

... das heißt, Sie können einfach von der README-Datei zum Wiki zurückkriechen, wie folgt:

[My Awesome Wiki](../../wiki)

Update: Wie einige Leute in den Kommentaren betont haben (danke!), Beachten Sie bitte, dass diese relativen Links auf Klonen und Gabeln brechen, also sollten Sie dies bei Ihrer Entscheidung abwägen!

— jmar777
quelle

15

Interessant, aber beachten Sie, dass README.md möglicherweise von einem lokalen Klon anstelle des Webs angezeigt wird. In diesem Fall funktioniert nur ein Link mit einer absoluten URL.

— Stéphane Gourichon

1

Guter Punkt, @ StéphaneGourichon, ich hatte nicht daran gedacht, die Readme vor Ort anzusehen. Obwohl ich denke, wenn relative Links gewünscht werden, ist dies eine akzeptable Einschränkung.

— jmar777

2

Sie können das Wiki lokal als separates Git-Repo klonen

— EriF89

3

Warnung: Wenn Sie einzelne Dateien wie einen README.mdund einen bestimmten Blob für ein Commit anzeigen, funktioniert dies nicht.

— Kaiser

Wie von Stephane Gourichon erwähnt, sind relative Links nicht immer der richtige Weg. Ein weiteres Beispiel ist, wenn Sie möchten, dass Ihr Paket über eine Open Source-Plattform eines Drittanbieters installiert werden kann. Für Python ist dies PyPi. PyPi wird in die Beschreibung geladen, aber alle relativen Links werden unterbrochen. In diesem Fall müssen Sie absolute URLs verwenden.

— cgnorthcutt

1

Nur um dies hinzuzufügen, wenn Sie aus dem Wiki heraus auf Ihre Repo-Datei verweisen möchten ../../blob/master/. In Kombination mit der Antwort von jmar777 können Code und Wiki vollständig integriert und die Notwendigkeit einer aufgeblähten readme.md beseitigt werden.

Damit es lokal funktioniert, müsste es auch Ihre Dateistruktur sein

./Wiki/YourWikiRepo
./blob/master/YourCodeRepo

— DfAC
quelle

1

Ich stellte fest, dass ich 3 Levels gegenüber 2 Levels zurückkriechen musste, wie in jmar777s Ansatz beschrieben.

Als ich verwendet habe

../../wiki

Der generierte Link war https://github.com/<username>/blob/wiki

Ich musste verwenden:

../../../wiki

Dies generiert https://github.com/<username>/wiki

— Grendel
quelle

1

Ich benutze GitLab. Mein Link zu meiner Wiki-Seite sieht so aus.

Checkout the [Wiki page](/%2E%2E/wikis/Welcome)

Ich habe die anderen Empfehlungen ausprobiert, die hier veröffentlicht wurden, aber die URL wurde durch erneutes Schreiben geändert, wodurch der Link unterbrochen wurde.

— LinuxGuru
quelle