Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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

like image 898
taufique Avatar asked Aug 23 '14 18:08

taufique


People also ask

How do I add a hyperlink to a README?

External Links To link inline, type the text you want to link within brackets, "[x]", followed directly by the link URL parentheses, "(y)". Reference-style linking allows you to give a link a number or "name" and refer to it multiple times.

How do I add a hyperlink in GitHub README?

Links. You can create an inline link by wrapping link text in brackets [ ] , and then wrapping the URL in parentheses ( ) . You can also use the keyboard shortcut Command + K to create a link.

Does GitLab use markdown?

GitLab uses "GitLab Flavored Markdown" (GFM). It extends the standard Markdown in a few significant ways to add some useful functionality. It was inspired by GitHub Flavored Markdown. You can also use other rich text files in GitLab.


1 Answers

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)

like image 133
taufique Avatar answered Sep 19 '22 13:09

taufique