Search code examples
gitlabgithub-flavored-markdown

Hyperlinks of README.md not working in Gitlab

I am working on a project that is being collaborated in Gitlab and tried to write the documentation using Github flavored markdown language. I added hyperlinks in following fashion. I learned it from the README.md of Async.js

### Functions
* [`tableList`](#tableList)

<a name="tableList"/>

### tableList ( callback )

Lists all the tables in connected database.


___Arguments___

* `callback`[Function] : Callback function

___Example___

```js
db_wrapper.tableList( function( err, response ){
    // Do something.
});
```

But in this way hyperlink is not appearing. What is the problem? Is the markdown syntax of Gitlab different from Github? My README.md file is here. And it appears like the image below.

Hyperlink appearance

Solution

  • In Github the syntax to add hyperlink is following - [Text](#section_name). But Gitlab doesn't support the same syntax. I don't know if it is a bug or something. In Gitlab hyperlinks need to be added just like the links. You need to give the full url, like following - [Text](full url of the section)