Give feedback

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:

.../tree/feature/CHANGE_LOG.md

and when I view the CHANGE_LOG.md file from the repository browser the functional link looks somehitng like this:

.../tree/feature/update_readme?path=CHANGE_LOG.md

1 vote
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
  • facebook
  • google
    Password icon
    Signed in as (Sign out)
    You have left! (?) (thinking…)
    Oskar shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →

    2 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      Signed in as (Sign out)
      Submitting...
      • Oskar commented  ·   ·  Flag as inappropriate

        I tried to use the link syntax suggested by Deveo Support:

        [CHANGE_LOG](?path=CHANGE_LOG.md)

        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 support@deveo.com (hopefully the small change in my settings fixes this)

      • AdminHelix TeamHub Support (Support, Helix TeamHub) commented  ·   ·  Flag as inappropriate

        Hi!

        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:

        [CHANGE_LOG](?path=CHANGE_LOG.md)

        Links to `.../tree/<branch name>?path=CHANGE_LOG.md`

        ---

        When the file is in a sub-folder:

        [chuck.rb](?path=lib/chuck.rb)

        Links to `.../tree/<branch name>?path=lib/chuck.rb`

        ---

        You can also link to raw files (opens or downloads the file directly):

        [CHANGE_LOG](raw-file:CHANGE_LOG.md)

        [chuck.rb](raw-file:lib/chuck.rb)

        ---

        To render images in the README.md, you can use the following syntax:

        ![image.png](raw-file:path/to/image.png)

        ---

        Hope this helps! We are looking into simplifying the syntax at some point in order to get rid of the `?path=` part.

      Feedback and Knowledge Base