¿Hay alguna manera de crear un ancla de URL <a>
, un enlace desde un archivo Markdown a otro archivo dentro del mismo repositorio y rama (también conocido como un enlace relativo a la rama actual)?
Por ejemplo, en la rama maestra tengo un archivo README.md, que me gustaría hacer algo como:
# My Project
is really really cool. My Project has a subdir named myLib, see below.
## myLib documentation
see documentation [here](myLib/README.md)
Esto me permitiría vincular de un .md a otro dentro de la misma rama y no tener que preocuparme por la rama en la que estoy (evite tener que hacer una URL absoluta que incluya el nombre de la rama github.com).
Aquí hay un ejemplo práctico de lo que quiero decir:
- GOTO http://github.com/rynop/testRel , el enlace no funciona.
- GOTO http://github.com/rynop/testRel/blob/master/README.md , enlace funciona.
Esto se espera porque en este punto la URL de inicio está en la rama. Ahora, ¿cómo consigo que recoja la rama actual en README.md en la raíz del repositorio?
Actualización : abrí un problema contra GitHub para esta solicitud de función.
Respuestas:
Actualización 30 de enero de 2013 , 16 meses después:
Publicación en el blog de GitHub Enlaces relativos en archivos de marcado :
Actualización 20 de diciembre de 2011:
El problema 84 del marcado de GitHub está actualmente cerrado por technoweenie , con el comentario:
12 de octubre de 2011:
Si observa la fuente sin procesar
README.md
de Markdown (!), Las rutas relativas no parecen ser compatibles.Encontrará referencias como:
fuente
[Welcome](./wiki/Hello)
funciona, donde Hello es otra página wiki en el mismo repositorio.[Welcome](Hello)
donde Hello es otra página wiki en el mismo repositorio.Por ejemplo, tiene un repositorio como el siguiente:
El enlace relativo a
subtext.md
intext.md
podría verse así:El enlace relativo a
subsubtext.md
intext.md
podría verse así:El enlace relativo a
subtext.md
insubsubtext.md
podría verse así:El enlace relativo a
subsubtext2.md
insubsubtext.md
podría verse así:El enlace relativo a
text.md
insubsubtext.md
podría verse así:fuente
A partir del 31 de enero de 2013, Github Markdown admite enlaces relativos a archivos .
Sin embargo, hay algunas deficiencias que se han discutido en este hilo de comentarios .
Como alternativa, puede usar Gitdown para construir URL completas para el repositorio e incluso hacer que se ramifiquen, p. Ej.
Gitdown es un preprocesador de rebajas de GitHub. Agiliza las tareas comunes asociadas con el mantenimiento de una página de documentación para un repositorio de GitHub, por ejemplo, generar una tabla de contenido, incluidas variables, generar URL y obtener información sobre el repositorio en sí en el momento de procesar la entrada. Gitdown se integra perfectamente con sus scripts de construcción.
Soy el autor de la biblioteca Gitdown.
fuente
GitHub podría hacer esto mucho mejor con un trabajo mínimo. Aquí hay una solución alternativa.
Creo que quieres algo más como
o para señalar el README mismo
Buena suerte
fuente
Solo quería agregar esto porque ninguna de las soluciones anteriores funcionó si el enlace de destino es un directorio con espacios en su nombre. Si el enlace de destino es un directorio y tiene espacio, incluso escapar del espacio con \ no representa el enlace en Github. La única solución que me funcionó es usar
%20
para cada espacio.por ejemplo: si la estructura del directorio es esto
Para hacer un enlace a
Dir A
README.md presente enTop_dir
usted, puede hacer esto:fuente
Puede vincular a un archivo, pero no a carpetas, y tenga en cuenta que Github agregará
/blob/master/
antes de su vínculo relativo (y las carpetas carecen de esa parte, por lo que no pueden vincularse, ni con<a>
etiquetas HTML ni con enlace de Markdown).Entonces, si tenemos un archivo
myrepo/src/Test.java
, tendrá una URL como:Y para vincularlo en el archivo Léame, podemos usar:
o:
<a href="src/Test.java">This is a link</a>
.(Supongo que
master
representa lamaster
rama y difiere cuando el archivo está en otra rama).fuente
Puede usar URL relativas desde la raíz de su repositorio con
<a href="">
. Suponiendo que su repositorio se llamatestRel
, ponga lo siguiente entestRel/README.md
:fuente
Esta pregunta es bastante antigua, pero aún parece importante, ya que no es fácil poner referencias relativas de readme.md a páginas wiki en Github.
Jugué un poco y este vínculo relativo parece funcionar bastante bien:
[Your wiki page](../../wiki/your-wiki-page)
Los dos
../
eliminarán/blob/master/
y usarán su base como punto de partida. Sin embargo, no he probado esto en otros repositorios que no sean Github (puede haber problemas de compatibilidad).fuente
No estoy seguro si veo esta opción aquí. Puede crear un
/folder
en su repositorio y usarlo directamente:No se necesita un nombre de blob o árbol o repositorio, y funciona de maravilla.
fuente
Si desea un enlace relativo a su página wiki en GitHub, use esto:
Si desea un enlace a un archivo en el repositorio, digamos, para hacer referencia a algún archivo de encabezado, y la página wiki está en la raíz de la wiki, use esto:
La razón de esto es omitir la ruta "/ wiki" con "../" e ir a la rama maestra en el árbol del repositorio sin especificar el nombre del repositorio, que puede cambiar en el futuro.
fuente