我可以在 Github Markdown 文档的代码块中包含 URL Link 吗?
Can I Include a URL Link Within a Chunk of Code in a Github Markdown Document?
我想为我雇主用 Github markdown (*.md) 编写的编码标准提出一些小的 tweaks/improvements。
我已经查阅了一些有关此 Markdown 语言格式约定的参考资料,做好了准备。
根据我的阅读,我发现我至少可以通过两种不同的方式添加 URL:
- 标准 HTML:
<a href="LINK_URL">TEXT</a>
- Markdown 样式 links:
[TEXT](LINK_URL)
...代码降价写为:
Markdown 风格:
```LANGUAGE
MY CODE;
```
- 通过 4 space 缩进的隐式代码表示。
但是,我一直无法找到关于您是否可以在代码块中包含 hyperlink 的参考(即该对象源在您的存储库中的位置)。
即我想做类似的事情:
```javascript
_myQObject: <a title="QML Source for MyQObject" href="URL_TO_SOURCE">MyQObject {}
```
但是,这行不通,而且我一直无法找到明确说明这是否可行的文档。
如何在格式化的 Github markdown 中包含 link 到 URL?
这可能吗?
作为参考,我查看过的基本风格指南是:
How can I include a link to a URL within a chunk of formatted Github markdown?
据我所知这是不可能的。
original Markdown specification says:
With a code span, ampersands and angle brackets are encoded as HTML entities automatically, which makes it easy to include example HTML tags.
…
Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block. This means it’s also easy to use Markdown to write about Markdown’s own syntax.
我在 GitHub Markdown 文档中没有看到任何内容表明他们在代码块中添加了对链接的支持,而且我尝试过的任何方法都没有奏效。
我也没有在任何其他 Markdown 实现中看到此功能。
这是一个迟到的回复,但是对于那些希望获得解决方案的人来说,有一种方法可以在预格式化的块中添加链接。如果您使用 HTML block with <pre> ... </pre>
instead of using the code block formatting sequence (i.e., don't use fenced code blocks or indented code blocks),则可以在预格式化文本块内使用 <a>
元素。例如
<pre>
myQObject: <a href="URL_TO_SOURCE">MyQObject {}</a>
</pre>
您失去了“适当”代码块提供的自动语法突出显示功能,因此需要权衡。
我想为我雇主用 Github markdown (*.md) 编写的编码标准提出一些小的 tweaks/improvements。
我已经查阅了一些有关此 Markdown 语言格式约定的参考资料,做好了准备。
根据我的阅读,我发现我至少可以通过两种不同的方式添加 URL:
- 标准 HTML:
<a href="LINK_URL">TEXT</a>
- Markdown 样式 links:
[TEXT](LINK_URL)
...代码降价写为:
Markdown 风格:
```LANGUAGE MY CODE; ```
- 通过 4 space 缩进的隐式代码表示。
但是,我一直无法找到关于您是否可以在代码块中包含 hyperlink 的参考(即该对象源在您的存储库中的位置)。
即我想做类似的事情:
```javascript
_myQObject: <a title="QML Source for MyQObject" href="URL_TO_SOURCE">MyQObject {}
```
但是,这行不通,而且我一直无法找到明确说明这是否可行的文档。
如何在格式化的 Github markdown 中包含 link 到 URL?
这可能吗?
作为参考,我查看过的基本风格指南是:
How can I include a link to a URL within a chunk of formatted Github markdown?
据我所知这是不可能的。
original Markdown specification says:
With a code span, ampersands and angle brackets are encoded as HTML entities automatically, which makes it easy to include example HTML tags.
…
Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block. This means it’s also easy to use Markdown to write about Markdown’s own syntax.
我在 GitHub Markdown 文档中没有看到任何内容表明他们在代码块中添加了对链接的支持,而且我尝试过的任何方法都没有奏效。
我也没有在任何其他 Markdown 实现中看到此功能。
这是一个迟到的回复,但是对于那些希望获得解决方案的人来说,有一种方法可以在预格式化的块中添加链接。如果您使用 HTML block with <pre> ... </pre>
instead of using the code block formatting sequence (i.e., don't use fenced code blocks or indented code blocks),则可以在预格式化文本块内使用 <a>
元素。例如
<pre>
myQObject: <a href="URL_TO_SOURCE">MyQObject {}</a>
</pre>
您失去了“适当”代码块提供的自动语法突出显示功能,因此需要权衡。