How to write a table of contents in a


I'm trying to add a table of contents into a for one of my repositories but I can't find a way to do it.

I tried to use the same syntax as GitHub, something similar to:

# Table of Contents

1. [My first title](#my-first-title)
2. [My second title](#my-second-title)
## My first title
Some text.
## My second title

But it doesn't work. Nothing happens when I click on the links generated into the ToC.

I'm running Bitbucket server 5.4. Is it possible to do such a thing please? I didn't find anything relevant into the Atlassian documentation.

Thanks for your help.


4 answers

1 accepted

3 votes
Accepted answer

For bitbucket server:

1. [ Description. ](#desc)
2. [ Usage tips. ](#usage)

<a name="desc"></a>
## 1. Description


<a name="usage"></a>
## 2. Usage tips


It works! Thank you very much!

Obviously works because, as you said, you are hosting your own bitbucket server.

Others, reading this post and using Markdown on does not allow HTML tags (for security reasons). and other Markdown environments do, so in a common Markdown editor on your PC it should work, but you cannot publish that on

On, just write "[TOC]", see

For other editors see their references. Retext, e.g., and maybe any Python based Markdown editor, allow to define "extensions", one of which is "markdown.extensions.toc" which provides the "[TOC]" functionality.

0 votes
Gonchik Tsymzhitov Community Champion Nov 19, 2017

Hi Guillaume, 

Have you tried this tutorial for



Hope it helps.



Gonchik Tsymzhitov

Hi Gonchik,

Thank you for your help, but it doesn't answered my question. I'm not trying to create a table (I have no problems for this), but a table of contents.



In other words: a list of links to the titles inside the README.


You need to add "markdown-header-" to your link parentheses.

1. [My First Title](#markdown-header-my-first-title)

2. [My Second Title](#markdown-header-my-second-title)


This worked for me.

This didn't work for me I tried with and without `markdown-header-`

Same for me... does not work...

same here, doesn't work...

Unfortunately you depend on the editor you are using. The built-in one on creates for a "##My First Title" headline an anchor "markdown-header-my-first-title", other editors may create an anchor "my_first_title", "My_First_Title_0", etc. - and some might produce no anchor at all. The reason is that this is no part of Markdown, but just a "service" from some editors.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Nov 06, 2018 in Bitbucket

Upgrade Best Practices

Hello! My name is Mark Askew and I am a Premier Support Engineer for products Bitbucket Server/Data Center, Fisheye & Crucible. Today, I want to bring the discussion that Jennifer, Matt, and ...

660 views 5 9
Read article

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you