使用Github Markdown语法引用一篇论文

Question

我正在为Github上的一个仓库编写自述文件，我想添加一篇论文的引用。在代码中最适当的引用方式是什么？例如作为块引用、代码、简单文本等等？

有什么建议吗？

- Pablo

Answer 1

我同意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.

"......“go to”语句应该被废除......"[1]。 参考文献 [1] Dijkstra，E.W.（1968）。 考虑到goto语句的危害。 ACM通讯，11（3），147-148。

在GitHub风格的Markdown和大多数其他Markdown风格中，您实际上可以单击[1]以跳转到引用。 很抱歉将Dijkstra的话断章取义。 完整的句子会使这个例子更难读懂。 编辑： 如果所有参考都有稳定的链接，则也可以使用这些链接： "

The field of natural language processing (NLP) has become mostly dominated by deep learning approaches
(Young et al., [2018](https://doi.org/10.1109/MCI.2018.2840738)).
Some are based on transformer neural networks
(e.g., Devlin et al, [2018](https://arxiv.org/abs/1810.04805)).

自然语言处理（NLP）领域现在主要由深度学习方法所主导（Young等人，2018）。其中一些方法是基于变压器神经网络的（例如Devlin等人，2018）。

- RikH

---

你能解释一下 [[1]](#1) 是如何工作的吗？我在 Markdown 语法中没有找到这种用法。谢谢。 - user

这只是通常语法中的链接，即 [link text](link)。但是，链接文本是 [1]，可能看起来令人困惑。 - RikH

非常感谢。有没有办法使参考文献列表更像一个编号列表？（即首行缩进和缩进文本换行）。 - Bill

你是指像这样的吗：1. Dijkstra, E. W. (1968). Go to statement considered harmful. Communications of the ACM, 11(3), 147-148.还是像这样的：1. Dijkstra, E. W. (1968).
Go to statement considered harmful.
Communications of the ACM, 11(3), 147-148. - AlGonzalez

Answer 2

据我所知，没有内置机制来实现此功能。这导致了更加主观的意见，取决于个人喜好。我个人喜欢有一个名为references的单独部分。示例如下：

参考文献

• 一些参考文献
• 另一个参考文献

更新

另一种方法是在您的Markdown中使用简单的HTML嵌入。

- Horizon_Net

---

听起来很公平。感谢您的反馈：） - Pablo

Answer 3

除了纯Markdown之外，还可以使用2021年8月的新GitHub集成：

增强GitHub对引用的支持

GitHub现在内置支持引用文件CITATION.cff。

这项新功能使学者和研究人员能够让人们知道如何正确引用他们的工作，特别是在学术出版物/材料中。

研究软件工程社区最初提出了CITATION.cff文件，它们是具有人类可读和机器可读引用信息的纯文本文件。
当我们检测到一个存储库中有CITATION.cff文件时，我们使用此信息创建方便的APA或BibTeX风格的引用链接，供他人引用。

工作原理

在幕后，我们使用ruby-cff RubyGem解析CITATION.cff文件的内容并构建一个引用字符串，然后在GitHub上展示给浏览带有这些文件的存储库的人们。

现在，这有助于使您的Github论文更容易被引用。但是，如所记录的，如果要“添加对论文的引用”，则可以使用CFF中的首选引用覆盖来链接到其他资源（例如研究文章）的GitHub引用信息，并使用以下类型：研究文章（article）、会议论文（conference-paper）和书籍（book）。

preferred-citation:
  type: article
  authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"

- VonC

---

问题是关于如何“添加论文参考文献”，而不是“使我的论文容易被引用”。 - RikH

@RikH 同意。我已经编辑了答案，包括允许引用其他资源（如研究文章）的语法。 - VonC

Answer 4

我刚在一个 GitHub 评论中看到了一个引用。他们称之为"脚注" as of 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.

重要的是，您可以在文本中的任何位置包含参考来源（方便地靠近实际提到参考的地方），并且它仍然会在底部呈现所有脚注。

- Chase