README.md的超链接在Gitlab中不起作用

时间:2014-08-23 18:39:11

标签: gitlab github-flavored-markdown

我正在开发一个在Gitlab中合作的项目,并尝试使用Github风格的降价语言编写文档。我以下面的方式添加了超链接。我是从Async.js

README.md中学到的
### 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.
});
```

但是这样超链接没有出现。问题是什么? Gitlab的markdown语法与Github不同吗?我的README.md文件为here。它看起来像下面的图像。

Hyperlink appearance

2 个答案:

答案 0 :(得分:2)

Github中,添加超链接的语法如下 - [Text](#section_name)。但是Gitlab并不支持相同的语法。我不知道这是不是一个bug或什么的。在Gitlab中,需要像链接一样添加超链接。您需要提供完整的网址,如下所示 - [Text](full url of the section)

答案 1 :(得分:1)

关于第一个链接,请确保在标题后留下一个空行:

### Functions

* [`tableList`](#tableList)

caolan/async/README.md包含链接:

## Documentation

### Collections

* [`each`](#each)
* [`eachSeries`](#eachSeries)

目标部分为:

<a name="each" />
### each(arr, iterator, callback

您需要在链接引用的部分之前添加锚点的名称。

请注意,应该有,因为GitLab 6。6(2014年2月)锚点会自动添加到降价文档的任何部分。
请参阅commit 61748c9Pull Request 6219以及suggestion 4533114