Link relativo a GitHub nel file Markdown

Esiste un modo per creare un ancoraggio URL <a>, collegamento dall'interno di un file Markdown, a un altro file all'interno dello stesso repository e ramo (ovvero un collegamento relativo al ramo corrente)?

Ad esempio, nel ramo master ho un file README.md, che vorrei fare qualcosa del tipo:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib documentation
see documentation [here](myLib/README.md)

Ciò mi consentirebbe di collegarmi da un .md all'altro all'interno dello stesso ramo e non dovrei preoccuparmi di quale ramo mi trovo (evitare di dover fare un URL assoluto che includa il nome del ramo github.com).

Ecco un esempio funzionante di cosa intendo:

1. GOTO http://github.com/rynop/testRel , il collegamento non funziona.
2. GOTO http://github.com/rynop/testRel/blob/master/README.md , collegamento funziona.

Ciò è previsto perché a questo punto l'URL iniziale si trova nel ramo. Ora come ottengo che raccolga il ramo corrente in README.md alla radice del repository?

Aggiornamento : ho aperto un problema con GitHub per questa richiesta di funzionalità.

Aggiornamento 30 gennaio 2013 , 16 mesi dopo:

Post sul blog di GitHub Link relativi nei file di markup :

A partire da oggi, GitHub supporta collegamenti relativi nei file di markup .
Ora puoi collegare direttamente tra diversi file di documentazione, sia che tu visualizzi la documentazione su GitHub stesso, sia localmente, usando un renderer di markup diverso.

Desideri esempi di definizioni di link e come funzionano? Ecco alcuni Markdown per te.
Invece di un collegamento assoluto:

[a link](https://github.com/user/repo/blob/branch/other_file.md)

... puoi usare un link relativo:

[a relative link](other_file.md)

e faremo in modo che sia collegato user/repo/blob/branch/other_file.md.

Se si utilizzava una soluzione alternativa come [a workaround link](repo/blob/master/other_file.md), è necessario aggiornare la documentazione per utilizzare la nuova sintassi.

Questo significa anche che la tua documentazione ora può essere facilmente autonoma, senza indicare sempre GitHub .

Aggiornamento del 20 dicembre 2011:

Il numero di markup GitHub 84 è attualmente chiuso da technoweenie , con il commento:

Abbiamo provato ad aggiungere un <base>tag per questo, ma causa problemi con altri collegamenti relativi sul sito.

12 ottobre 2011:

Se osservi la fonte nonREADME.md elaborata di Markdown stesso (!), I percorsi relativi non sembrano essere supportati.
Troverai riferimenti come:

[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13

Ad esempio, hai un repository come il seguente:

project/
    text.md
    subpro/
       subtext.md
       subsubpro/
           subsubtext.md
       subsubpro2/
           subsubtext2.md

Il collegamento relativo a subtext.mdin text.mdpotrebbe essere simile al seguente:

[this subtext](subpro/subtext.md)

Il collegamento relativo a subsubtext.mdin text.mdpotrebbe essere simile al seguente:

[this subsubtext](subpro/subsubpro/subsubtext.md)

Il collegamento relativo a subtext.mdin subsubtext.mdpotrebbe essere simile al seguente:

[this subtext](../subtext.md)

Il collegamento relativo a subsubtext2.mdin subsubtext.mdpotrebbe essere simile al seguente:

[this subsubtext2](../subsubpro2/subsubtext2.md)

Il collegamento relativo a text.mdin subsubtext.mdpotrebbe essere simile al seguente:

[this text](../../text.md)

Al 31 gennaio 2013 il markdown di Github supporta collegamenti relativi ai file .

[a relative link](markdown_file.md)

Tuttavia, ci sono alcune carenze che sono state discusse in questo thread di commenti .

In alternativa, puoi utilizzare Gitdown per costruire URL completi nel repository e persino renderli consapevoli del ramo, ad es

{"gitdown": "gitinfo", "name": "url"} // https://github.com/gajus/gitdown
{"gitdown": "gitinfo", "name": "branch"} // master

Gitdown è un preprocessore di markdown GitHub. Semplifica le attività comuni associate alla gestione di una pagina di documentazione per un repository GitHub, ad esempio la generazione di un sommario, comprese le variabili, la generazione di URL e la raccolta di informazioni sul repository stesso al momento dell'elaborazione dell'input. Gitdown si integra perfettamente con i tuoi script di costruzione.

Sono l'autore della biblioteca di Gitdown.

GitHub potrebbe renderlo molto migliore con un lavoro minimo. Ecco una soluzione.

Penso che tu voglia qualcosa di più simile

[Your Title](your-project-name/tree/master/your-subfolder)

o per indicare il README stesso

[README](your-project-name/blob/master/your-subfolder/README.md)

In bocca al lupo

Volevo solo aggiungere questo perché nessuna delle soluzioni sopra ha funzionato se il link di destinazione è una directory con spazi nel suo nome. Se il link di destinazione è una directory e ha spazio, anche il escape dello spazio con \ non rende il link su Github. L'unica soluzione che ha funzionato per me sta usando %20per ogni spazio.

es: se la struttura delle directory è questa

Top_dir
|-----README.md
|-----Cur_dir1
      |----Dir A
           |----README.md
      |----Dir B
           |----README.md

Per rendere il collegamento a Dir AREADME.md presente in Top_dirte puoi fare questo:

[Dir 1](Cur_dir1/Dir%20A)

Puoi collegarti a file, ma non a cartelle, e tieni presente che, Github aggiungerà /blob/master/prima del tuo collegamento relativo (e le cartelle mancano di quella parte in modo che non possano essere collegate, né con <a>tag HTML o collegamento Markdown).

Quindi, se abbiamo un file myrepo/src/Test.java, avrà un url come:

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

E per collegarlo nel file Leggimi, possiamo usare:

[This is a link](src/Test.java)

o: <a href="src/Test.java">This is a link</a>.

(Immagino che masterrappresenti il masterramo e differisce quando il file si trova in un altro ramo.)

È possibile utilizzare gli URL relativi dalla radice del repository con <a href="">. Supponendo che il proprio repository sia denominato testRel, inserire quanto segue testRel/README.md:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib docs
see documentation:
    * <a href="testRel/myLib">myLib/</a>
    * <a href="testRel/myLib/README.md">myLib/README.md</a>

Questa domanda è piuttosto vecchia, ma sembra comunque importante, poiché non è facile inserire riferimenti relativi da readme.md alle pagine wiki su Github.

Ho giocato un po 'in giro e questo link relativo sembra funzionare abbastanza bene:

[Your wiki page](../../wiki/your-wiki-page)

I due ../rimuoveranno /blob/master/e useranno la tua base come punto di partenza. Non ho provato questo su altri repository oltre a Github (potrebbero esserci problemi di compatibilità).

Non sono sicuro di vedere questa opzione qui. Puoi semplicemente creare un /foldernel tuo repository e usarlo direttamente:

[a relative link](/folder/myrelativefile.md)

Non è necessario alcun BLOB o nome albero o repository e funziona come un incantesimo.

Se vuoi un link relativo alla tua pagina wiki su GitHub, usa questo:

Read here: [Some other wiki page](path/to/some-other-wiki-page)

Se si desidera un collegamento a un file nel repository, diciamo, per fare riferimento a un file di intestazione e la pagina wiki è alla radice del wiki, utilizzare questo:

Read here: [myheader.h](../tree/master/path/to/myheader.h)

La logica dell'ultimo è saltare il percorso "/ wiki" con "../" e andare al ramo principale nella struttura del repository senza specificare il nome del repository, che potrebbe cambiare in futuro.