使用GitHub Markdown

时间:2015-12-28 14:42:27

标签: github markdown overlap

我们正在尝试为易于维护的文档实现自动降价生成器。

当提及变量的类型时,我们希望在它可以为空时使用?作为前缀,在它周围使用反引号并添加指向其描述的链接。例如:`?[Article](#article)`

但是,由于重叠,反引号会破坏链接语法。我们使用`?`[`Article`](#article)代替链接,但它会在?Article之间创建一个空格,如下所示:? Article

是否可以仅使用?Article上的链接使其显示为Article

1 个答案:

答案 0 :(得分:2)

我刚测试了这一点,发现?Article之间有没有空格。看似空间的只是GitHub的两个<code>块相互对立的造型。

将整个内容包装在反引号中是行不通的,因为反引号表示代码,而Markdown将内容视为您想要显示源的代码示例。

我能找到的最佳解决方法是直接使用<code>标记:

<code>?[Article](https://stackoverflow.com/)</code>

在GitHub和Stack Overflow上,渲染如下:

?Article

(我在这里使用了Stack Overflow链接作为链接目标,因此我们以渲染链接为例。我希望#article在您的环境中同样有效。)

在我看来,这甚至是做你想做的事情的合理方式。 Markdown的反引号编译为<code>标记,inline HTML code is expressly permitted by Markdown

  

对于Markdown语法未涵盖的任何标记,您只需使用HTML本身。没有必要为它添加前缀或分隔它以表明您正在从Markdown切换到HTML;你只需使用标签。