【问题标题】:Can I Include a URL Link Within a Chunk of Code in a Github Markdown Document?我可以在 Github Markdown 文档的代码块中包含 URL 链接吗?
【发布时间】:2016-06-21 20:54:16
【问题描述】:

我希望对我的雇主用 Github markdown (*.md) 编写的编码标准提出一些小的调整/改进。

我已经通过查看该 Markdown 语言的格式约定的几个参考资料做好了准备。

从我的阅读中,我发现我可以通过至少两种不同的方式添加 URL:

  • 标准 HTML:
    <a href="LINK_URL">TEXT</a>
  • Markdown 样式链接:
    [TEXT](LINK_URL)

...和代码markdown写成:

  • Markdown 样式:

    ```LANGUAGE MY CODE; ```

  • 通过 4 个空格缩进的隐式代码表示。

但是,我一直无法找到有关您是否可以在代码块中包含超链接的参考资料(即指向您的存储库中该对象源的位置)。

即我想做类似的事情:

```javascript
_myQObject: <a title="QML Source for MyQObject" href="URL_TO_SOURCE">MyQObject {}
```

但是,这不起作用,而且我一直无法找到明确说明这是否可行的文档。

如何在格式化的 Github markdown 块中包含指向 URL 的链接?

这可能吗?

作为参考,我查看过的基本风格指南是:

【问题讨论】:

    标签: url github markdown code-formatting github-flavored-markdown


    【解决方案1】:

    如何在一大块格式化的 Github markdown 中包含指向 URL 的链接?

    据我所知这是不可能的。

    original Markdown specificationsays:

    使用代码跨度,与号和尖括号会自动编码为 HTML 实体,这使得包含示例 HTML 标记变得容易。

    常规 Markdown 语法不在代码块内处理。例如,星号只是代码块中的文字星号。这意味着使用 Markdown 来编写 Markdown 自己的语法也很容易。

    我在 GitHub Markdown 文档中没有看到任何内容表明他们在代码块中添加了对链接的支持,而且我尝试过的任何方法都没有奏效。

    我还没有在任何其他 Markdown 实现中看到此功能。

    【讨论】:

    • 啊,那很不幸...我将使用我的失败,即在代码块上方放置一个带有链接文件名的标签。谢谢,克里斯。如果他们确实实施了此解决方案,请更新此解决方案!
    • Markdown 的某些变体打破了规则,这几乎是 Markdown 的规则。在这种情况下,Stack Exchange allows you to put a link into blocks,如果你问得好的话。
    【解决方案2】:

    这是一个迟到的回复,但对于希望找到解决方案的人来说,有一种方法可以在预格式化的块中添加链接。如果您使用HTML block&lt;pre&gt; ... &lt;/pre&gt; 而不是 使用代码块格式化序列(即不要使用fenced code blocksindented code blocks),那么您可以使用&lt;a&gt; 元素在预格式化的文本块内。例如

    <pre>
      myQObject: <a href="URL_TO_SOURCE">MyQObject {}</a>
    </pre>
    

    您失去了“正确”代码块提供的自动语法突出显示,因此需要权衡。

    【讨论】:

      猜你喜欢
      • 2021-10-11
      • 2013-12-04
      • 1970-01-01
      • 1970-01-01
      • 2015-01-16
      • 1970-01-01
      • 2020-08-12
      • 2019-04-13
      • 1970-01-01
      相关资源
      最近更新 更多