enlace de github a la página wiki de README

91

¿Cómo creo un enlace desde un archivo README.md a una página Wiki en github? Cada ejemplo parece mostrar la vinculación de una página wiki a otra página wiki, o de un archivo README a otro archivo en el repositorio. Pero ninguno que muestre vinculación de uno a otro

github

— veilig
fuente

Tienes razón. "de un archivo a otro archivo README en el repositorio" no trabajo, ref oficial help.github.com/articles/relative-links-in-readmes~~V~~singular~~3rd blog oficial github.com/blog/1395-relative-links-in-markup- archivos , consulte también bibwild.wordpress.com/2013/01/30/… .

— Stéphane Gourichon

Perspicaz acerca de por qué el enlace de README a wiki no es tan deseable: "Claro, podría enlazar a su wiki, pero wiki no tiene una versión junto con el código fuente y desea enlazar a la versión de los documentos que acompañan a la instantánea exacta del repositorio de origen que está viendo. Claro, puede vincular utilizando hipervínculos de URL absolutos, pero el mismo problema, siempre está vinculando al maestro, cuando desea vincular al archivo en la misma instantánea que el lector está mirando el archivo README en ". Fuente: bibwild.wordpress.com/2013/01/30/…

— Stéphane Gourichon

67

Tendría que usar una URL absoluta en lugar de una relativa.

Por ejemplo:

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

— maxdeviant
fuente

4

ok, eso es lo que pensé, solo quería asegurarme de que no hubiera una mejor manera.

— Veilig

2

En el documento vinculado por @ jmar777, advierte sobre el uso de URL absolutas: "Los usuarios que clonen su repositorio tendrán más dificultades para que los enlaces funcionen de lo esperado".

— Dave Sexton

@DaveSexton Eso se refiere específicamente a vincular a otros archivos en el repositorio (que siempre será relativo al README). Al vincular a algo externo (como una wiki), desea utilizar URL absolutas.

— maxdeviant

92

Me encontré con esta pregunta y vi que esto era imposible, pero de todos modos seguí intentándolo obstinadamente. Buenas noticias, ¡porque esto se puede hacer con enlaces relativos!

Si observa la documentación de los enlaces relativos en GitHub , puede ver que admite ./y ../operandos.

Dado que su archivo README se encuentra en:

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

... y la wiki se encuentra en:

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

... eso significa que puede volver a rastrear desde el archivo README hasta la wiki, así:

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

Actualización: como algunas personas han señalado en los comentarios (¡gracias!), Tenga en cuenta que estos enlaces relativos se romperán en clones y bifurcaciones, ¡así que asegúrese de sopesar eso en su decisión!

— jmar777
fuente

15

Interesante, pero tenga en cuenta que el archivo README.md puede verse desde un clon local en lugar de desde la web. En ese caso, lo único que funciona es un enlace con URL absoluta.

— Stéphane Gourichon

1

Buen punto, @ StéphaneGourichon, no había considerado la visualización local del Léame. Aunque supongo que si se desean enlaces relativos, esa es una limitación aceptable.

— jmar777

2

Puede clonar la wiki localmente como un repositorio de git separado: stackoverflow.com/questions/15080848/…

— EriF89

3

Advertencia: al ver archivos individuales como un README.mdy un blob específico para una confirmación, esto no funcionará.

— Kaiser

Como lo mencionó Stephane Gourichon, los vínculos relativos no siempre son el camino a seguir. Otro ejemplo es si desea que su paquete se pueda instalar a través de una plataforma de código abierto de terceros. Para Python, esto es PyPi. PyPi se cargará en la descripción, pero todos los enlaces relativos se romperán. Necesita ir con URL absolutas en este caso.

— cgnorthcutt

1

Solo para agregar en este, si desea consultar su archivo de repositorio desde dentro, use wiki ../../blob/master/ . Combinado con la respuesta de jmar777, esto permite integrar completamente el código y la wiki y eliminar la necesidad de un readme.md inflado.

Para que funcione localmente, así como su estructura de archivos, tendría que ser

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

— DfAC
fuente

1

Descubrí que necesitaba retroceder 3 niveles frente a 2 niveles como se describe en el enfoque de jmar777.

Cuando usé

../../wiki

El enlace generado fue https://github.com/<username>/blob/wiki

Necesitaba usar:

../../../wiki

Esto generó https://github.com/<username>/wiki

— Grendel
fuente

1

Estoy usando GitLab. Mi enlace a mi página Wiki se ve así.

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

Probé las otras recomendaciones que se publican aquí, pero seguí cambiando la URL con reescrituras que rompieron el enlace.

— LinuxGuru
fuente