The markdown link from README to another file does not work.
This is not a new idea just a bug.
When I have a README.md file in a branch named "feature/XY" the link to another file like CHANGE_LOG.md does not work as expected. The generated link in README.md file looks like something like:
and when I view the CHANGE_LOG.md file from the repository browser the functional link looks somehitng like this:
I tried to use the link syntax suggested by Deveo Support:
This is not a working solution for us because we are using same files in Doxygen document generation. The Doxygen complains about the link:
.... README.md:66: warning: unexpected token TK_EOF as the argument of ref
BTW I didn't receive any mail from email@example.com (hopefully the small change in my settings fixes this)
You can use relative links in order to link to files. Here's a few tips (a general note - this only works for READMEs written in Markdown):
Linking to files (opens inside the repository browser):
When the file is in the same root directory as README.md:
Links to `.../tree/<branch name>?path=CHANGE_LOG.md`
When the file is in a sub-folder:
Links to `.../tree/<branch name>?path=lib/chuck.rb`
You can also link to raw files (opens or downloads the file directly):
To render images in the README.md, you can use the following syntax:
Hope this helps! We are looking into simplifying the syntax at some point in order to get rid of the `?path=` part.