github - github マークダウン構文を使用して論文を引用する

Question

私は github でレポの readme をコーディングしており、論文への参照を追加したいと考えています。引用をコード化する最も適切な方法は何ですか? たとえば、引用符、コード、単純なテキストなどでしょうか。

提案？

Answer 1

私の知る限り、これには組み込みのメカニズムはありません。これは、個人の好みに応じて、より主観的な意見につながります。個人的には、referencesという別のセクションを設けるのが好きです。例は次のようになります

参考文献

• いくつかの参照
• 別の参照

アップデート

もう 1 つの方法は、Markdown に埋め込まれた単純な HTML を使用することです。

Answer 2

(純粋なマークダウンに代わる) 方法は、2021 年 8 月からの新しい GitHub 統合を使用することです。

GitHub での引用のサポートの強化

GitHub には、ファイルのサポートが組み込まれCITATION.cffています。

この新しい機能により、学者や研究者は、特に学術出版物/資料で、自分の研究を正しく引用する方法を人々に知らせることができます。

研究ソフトウェア エンジニアリング コミュニティによって最初に提案されたCITATION.cffファイルは、人間と機械が読み取り可能な引用情報を含むプレーン テキスト ファイルです。
リポジトリで CITATION.cff ファイルを検出すると、この情報を使用して、他のユーザーが参照できる便利なAPAまたはBibTeXスタイルの引用リンクを作成します。

これがどのように機能するか

内部的には、 ruby-cff RubyGem を使用してCITATION.cffファイルの内容を解析し、引用文字列を作成します。引用文字列は、誰かがそれらのファイルの 1 つを含むリポジトリを参照したときに GitHub に表示されます1。

これで、他の人があなたの Github 論文を簡単に引用できるようにすることができます。

しかし、文書化されているように、「論文への参照を追加する」には：

ソフトウェア以外のものを引用する

GitHub の引用情報を研究記事などの別のリソースにリンクしたい場合は、次のタイプで CFF の優先引用オーバーライドを使用できます。

リソース	タイプ
研究論文	論文
会議資料	会議資料
本	本

エキス

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