Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,298,158
Community Members
 
Community Events
165
Community Groups

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

 

10 answers

3 accepted

8 votes
Answer accepted

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

Jan 2020: I can confirm that Arito's approach works.

  1. there is no need to include the page name
  2. every in-page link has to include the following prefix: #markdown-header-

Personally, I find it frustrating how Atlassian continues to use it's own proprietary implementations.

  • First there was Markup.
  • Now that BitBucket finally supports MarkDown, they use a magic prefix for for in-page hyperlinks
Like # people like this

Personally, I find it frustrating how Atlassian continues to use it's own proprietary implementations.

I agree, it's very frustrating.

Like # people like this

Is there an existing issue on Atlassian Jira for removing the annoying prefix that I could go vote on?

Like # people like this

@Marko Kirves , I wasn't able to find the issue, so I created the one :)

Like Andreas Johansson likes this
8 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.

Deleted user Sep 11, 2018

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 # people like this

Same as @[deleted] for me

I am also experiencing the same issue as @[deleted] describes.

Like Kevin Miller likes this

Same as Rafael

Functionality still broken!!! :/

Like # people like this

Same as Rafael It just shows a text.

Jeff (or other Atlassian team member),

Your approach works in my hands.  I would like "id" attribute to also work.  It does now. It should per html spec I think.  Can fix in bitbucket on prem?

 

I want this to work too:

<a id="section"></a>

This doesn't work. I did as Jeff suggested...no joy. Apparently a link [return to top](#top) works even though I don't have a link or section header named 'top'. But the other links are dead.

ok so I did eventually get it working, the trick is to commit often and then inspect the id for the header tags and copy/paste--however it seems you can not link to any subheader; that is internal links to #section work, while a hyperlink to ##section-subsection, will not work.

3 votes
Answer accepted

We can do something like this

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

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

 

# Configuration

This did not work for me, but the above ref using html <a> tag did work

Different scopes:

  • The markdown-header- prefix is used in Bitbucket Cloud (bitbucket.org)
  • The HTML anchor is used in Bitbucket Server

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 # people like this

This was the only one that worked for me. Thank you!

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.

Is there some solution to section links work? 

This feature is really practical for long docs.

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

I'm seeing anchors being rendered as well.  I had such high hopes of using this wiki product too.

I'm not sure whether I'm complete mislooking this functionality, but I'm not able to get my wiki work.

Markdown elements are perfectly converted/applied in the Edit > Preview, but NOT in the wiki-url display. 

Some examples:

  • # Heading one
    when showing in preview, this has 'markdown-heading-heading-one' as ID anchor
    when showing in BitBucket wiki no id is generated, but text is wrapped in <h1>
  • [TOC]
    when showing in preview, a complete Table Of Content is generated, with working links
    when showing in Bitbucket wiki '[TOC]' is shown.

So it kind of seems the Bitbucket wiki display uses different libraries to process the markdown to display in the front-end (end-users) vs. what is shown in Preview.

Is this a known issue, or maybe some repository settings I'm missing?

Thanks in advance! 

it's already 2020 and this still not working.. :|

Like # people like this

Internal links still not working - using `<a name="foo"></a>` just renders the anchor as text. Any solutions for this?

Suggest an answer

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

Git push size limits are coming to Bitbucket Cloud starting April 4th, 2022

Beginning on April 4th, we will be implementing push limits. This means that your push cannot be completed if it is over 3.5 GB. If you do attempt to complete a push that is over 3.5 GB, it will fail...

2,224 views 2 9
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