It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Markdown internal links support in Bitbucket Server

Is it possible to use internal links in Markdown files?

None of these ways works in version 4.14:
 
[Link Title](#markdown-header-testlink)
[Link Title](#testlink)

some text
........

# Testlink
some text

 

6 answers

1 accepted

4 votes
Answer accepted
Jeff Thomas Atlassian Team Jun 07, 2017

Hi Pavel,

Yes this is possible. In your Markdown create a link at the top:

[link](#section)

and in the body of your document, create the anchor:

<a name="section"></a>

 

Great! It works. Thanks!

This doesn't seem to work in Bitbucket 5.3.2. Is there a different solution for that version?

if you found any solution please tell me :) 

This issue is supposedly fixed in Bitbucket Server 5.3.4 and 5.4.2, but I don't currently have access to either of these versions to verify. See https://jira.atlassian.com/browse/BSERV-10210 for details.

This works for me on v5.11.1 Bitbucket Server.

It is not working for me. It is rendering <a name="target"></a> as text and no navigation. I can navigate with other markdown viewers.

Like zorantus likes this

I am also experiencing the same issue as @Rafael García describes.

Same as Rafael

Functionality still broken!!! :/

Same as Rafael It just shows a text.

For me it works like this:

[Configuration](#markdown-header-configuration)

The difference between the above and the solution proposed by @Hajaniaina R (web) is that I am omitting the README.md

The `<a>` tag in the header file did not work in my case (Feb. 2019).

 

What I did let the README.md file rendered as-is and then right-click the corresponding header I wanted to link to, choose inspect from the context menu (I use chrome, choose the similar option in your browser).

 

You will see generated html similar to the following:

<h1 id="markdown-header-your-awesome-header">...

 

Use then this ID tag to link to the header from your code like:

[this is my link](#markdown-header-your-awesome-header)

 

This is the one, folks! Nice one, Konstantin.

Yea, that works, but that requires manually a edited README (so no typedoc with markdown theme) and frankly it breaks the markdown standard. What a bummer.

Like emilymerwin likes this

We can do something like this

PS: we must add "markdown-header-"  before the id of section

* [Configuration](documentation.md#markdown-header-configuration)

 

# Configuration

Add the text "[TOC]" to the beginning of the document for it to be generated.

In-document links no longer work. Even in this markdown example https://bitbucket.org/tutorials/markdowndemo/src/master/ clicking on any in-document link just reloads the same markdown file but does not jump to the heading.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published in Bitbucket

Atlassian supported Jenkins integration for Bitbucket Server

We’ve been building a plugin to integrate Bitbucket Server and Jenkins CI, and I’m excited to announce that our alpha is ready to download and install. It lets you seamlessly configure a Jenkins job ...

497 views 0 10
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you