我希望对我的雇主用Github markdown(* .md)编写的编码标准提出一些小的调整/改进。
我已经准备好了一些参考这种降价语言的格式约定。
根据我的阅读材料,我发现我可以通过至少两种不同的方式添加网址:
<a href="LINK_URL">TEXT</a>
[TEXT](LINK_URL)
...并且代码降价写为:
Markdown风格:
```LANGUAGE
MY CODE;
```
但是,我无法找到关于您是否可以在代码块中包含超链接的引用(即,在您的存储库中包含该对象源的位置)。
即。我想做点什么:
```javascript
_myQObject: <a title="QML Source for MyQObject" href="URL_TO_SOURCE">MyQObject {}
```
然而,这不起作用,我一直无法找到明确说明这是否可行的文件。
如何在格式化的Github降价块中包含指向URL的链接?
这可能吗?
作为参考,我所评论的基本风格指南是:
答案 0 :(得分:1)
如何在格式化的Github markdown中包含指向URL的链接?
据我所知,这是不可能的。
original Markdown specification says:
使用代码范围,&符号和尖括号自动编码为HTML实体,这样可以轻松包含示例HTML标记。
...
在代码块中不处理常规Markdown语法。例如,星号只是代码块中的字面星号。这意味着使用Markdown编写Markdown自己的语法也很容易。
我没有在GitHub Markdown文档中看到任何建议他们已经添加了对代码块中链接的支持,并且我尝试过的任何内容都没有。
我还没有在任何其他Markdown实现中看到过这个功能。
答案 1 :(得分:0)
这是一个迟到的回复,但对于来这里寻求解决方案的人来说,有一种方法可以在预格式化的块中添加链接。如果您将 HTML block 与 <pre> ... </pre>
一起使用,而不是使用代码块格式化序列(即,不要使用 fenced code blocks 或 indented code blocks),然后,您可以在预格式化的文本块中使用 <a>
元素。例如
<pre>
myQObject: <a href="URL_TO_SOURCE">MyQObject {}</a>
</pre>
您失去了“正确”代码块提供的自动语法突出显示,因此需要进行权衡。