README의 wiki 페이지에 대한 github 링크

91

README.md 파일에서 github의 Wiki 페이지로 연결되는 링크를 어떻게 생성합니까? 모든 예제는 한 위키 페이지에서 다른 위키 페이지로 또는 한 README 파일에서 저장소의 다른 파일로 링크하는 것을 보여줍니다. 그러나 하나에서 다른 것으로 연결되는 것을 보여주는 것은 없습니다.

github

— 베일 릭
소스

네가 옳아. "한 README 파일에서 저장소의 다른 파일로"가 작동합니다. 공식 ref help.github.com/articles/relative-links-in-readmes 공식 블로그 github.com/blog/1395-relative-links-in-markup- 파일 , bibwild.wordpress.com/2013/01/30/… 참조 .

— Stéphane Gourichon 2015

README에서 위키로의 링크가 그다지 바람직하지 않은 이유에 대한 통찰력 : "물론, 위키로 링크 할 수는 있지만 위키는 소스 코드와 함께 버전이 지정되어 있지 않으며 함께 제공되는 문서 버전으로 링크하고 싶습니다. 보고있는 소스 저장소의 정확한 스냅 샷입니다. 물론 절대 URL 하이퍼 링크를 사용하여 링크 할 수 있습니다. 그러나 동일한 문제는 독자가 동일한 스냅 샷의 파일에 링크하려는 경우 항상 마스터에 링크합니다. 에서 README를보고 있습니다. " 출처 : bibwild.wordpress.com/2013/01/30/...

— 스테판 구리 콘

67

상대 URL이 아닌 절대 URL을 사용해야합니다.

예를 들면 :

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

— maxdeviant
소스

4

좋아, 그게 내가 생각한 것입니다. 더 나은 방법이 없는지 확인하고 싶었습니다.

— veilig

2

@ jmar777에 의해 링크 된 문서에서 절대 URL 사용에 대해 경고합니다. "저장소를 복제하는 사용자는 예상보다 링크를 작동시키는 데 훨씬 더 많은 시간을 할애 할 것입니다."

— Dave Sexton 2016 년

@DaveSexton 이는 특히 저장소의 다른 파일에 대한 링크를 의미합니다 (항상 README에 상대적 임). 외부 (예 : 위키)에 연결할 때 절대 URL을 사용하려고합니다.

— maxdeviant

93

나는 방금이 질문을 보았고 이것이 불가능하다는 것을 알았지 만 어쨌든 고집스럽게 시도했습니다. 좋은 소식입니다. 이것은 실제로 상대 링크로 수행 할 수 있기 때문입니다!

GitHub의 상대 링크에 대한 문서를 보면 지원 ./및 ../피연산자 를 확인할 수 있습니다 .

README의 위치는 다음과 같습니다.

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

... 위키는 다음 위치에 있습니다.

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

... 즉, 다음과 같이 README에서 위키로 다시 크롤링 할 수 있습니다.

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

업데이트 : 일부 사람들이 의견 (감사합니다!)에서 지적했듯이 이러한 관련 링크가 클론과 포크에서 깨질 수 있다는 점에 유의하십시오.

— jmar777
소스

15

흥미롭지 만 README.md는 웹 대신 로컬 복제에서 볼 수 있습니다. 이 경우 작동하는 유일한 것은 절대 URL이있는 링크입니다.

— Stéphane Gourichon 2015

1

좋은 지적, @ StéphaneGourichon, Readme의 로컬보기를 고려하지 않았습니다. 상대 링크가 필요한 경우 허용 가능한 제한이라고 생각합니다.

— jmar777

2

별도의 자식이 REPO 같이 로컬 위키를 복제 할 수 있습니다 stackoverflow.com/questions/15080848/...

— EriF89에게

3

경고 : a README.md와 같은 단일 파일 및 커밋에 대한 특정 Blob을 볼 때는 작동하지 않습니다.

— kaiser

Stephane Gourichon이 언급했듯이 상대 연결이 항상가는 길이는 아닙니다. 또 다른 예는 타사 오픈 소스 플랫폼을 통해 패키지를 설치하려는 경우입니다. Python의 경우 PyPi입니다. PyPi는 설명에로드되지만 모든 관련 링크가 끊어집니다. 이 경우 절대 URL을 사용해야합니다.

— cgnorthcutt

1

이 파일에 추가하려면 wiki 내부에서 repo 파일을 참조하려면 ../../blob/master/. jmar777의 답변과 결합하면 코드와 위키를 완전히 통합하고 비대해진 readme.md의 필요성을 제거 할 수 있습니다.

파일 구조뿐만 아니라 로컬에서 작동하도록하려면

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

— DfAC
소스

1

jmar777의 접근 방식에서 설명 된대로 3 단계 대 2 단계 뒤로 크롤링해야한다는 것을 알았습니다.

내가 사용했을 때

../../wiki

생성 된 링크는 https://github.com/<username>/blob/wiki

다음을 사용해야했습니다.

../../../wiki

이것은 생성 https://github.com/<username>/wiki

— Grendel
소스

1

GitLab을 사용하고 있습니다. 내 Wiki 페이지에 대한 링크는 다음과 같습니다.

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

여기에 게시 된 다른 권장 사항을 시도했지만 링크를 끊은 재 작성으로 URL을 계속 변경했습니다.

— LinuxGuru
소스