Pab*_*blo 6 github github-flavored-markdown
我正在为github中的repo编写自述文件,我想添加对文章的引用.在引文中编码最合适的方法是什么?例如,作为一个块引用,作为代码,作为简单的文本等?
建议?
Rik*_*ikH 37
我同意 Horizon_Net 的观点,这取决于个人喜好。我喜欢有一些看起来类似于 LaTeX 的东西。下面提供了一个示例。请注意,它演示了数字引用样式。字母或阅读风格也是可能的。对于数字引用样式,更高的数字应该出现在文本的后面,这会使满足数字引用样式变得麻烦。为了避免这个问题,我通常使用字母引用样式。
"...the **go to** statement should be abolished..." [[1]](#1).
## References
<a id="1">[1]</a>
Dijkstra, E. W. (1968).
Go to statement considered harmful.
Communications of the ACM, 11(3), 147-148.
Run Code Online (Sandbox Code Playgroud)
“...... go to语句应该被废除......” [1]。
参考
[1] Dijkstra, EW (1968)。转到被认为有害的声明。ACM 通讯,11(3),147-148。
在 GitHub 风格的 Markdown 和大多数其他 Markdown 风格上,您实际上可以单击 [1] 跳转到参考。为将 Dijkstra 的句子断章取意而道歉。完整的句子会使这个例子更难阅读。
据我所知,没有内置机制.根据个人喜好,这会产生更多主观意见.我个人喜欢有一个叫做引用的单独部分.示例如下所示
更新
另一种方法是使用Markdown中嵌入的简单HTML.
我刚刚在 github 评论中看到了一条引用。自 2021 年起,他们将其称为“脚注” 。
语法是使用 链接到文本中的脚注[^1]
,然后在以同一链接开头的单独行中包含扩展的参考。
Here is a simple footnote[^1]. With some additional text after it.
[^1]: My reference, with further explanation and a [supporting link](https://website.com).
Here is another footnote[^2].
[^2]: Another reference.
Run Code Online (Sandbox Code Playgroud)
重要的是,您可以在文本中的任何位置包含参考源(方便地更接近实际提到参考的位置),并且它仍然会与所有脚注一起呈现在底部。
归档时间: |
|
查看次数: |
2528 次 |
最近记录: |