GitHub風味のMarkdownに脚注を追加する方法は?


273

私はGitHub Gistに脚注を追加しようとしていますが、機能しません。

Some long sentence. [^footnote]

[^footnote]: Test, [Link](https://google.com).

私はこのガイドに従っおり、私は何か間違っているとは思いません。誰かが私の間違いを指摘できますか?


1
fletcher.github.io/peg-multimarkdown 注:現在、Github wikiソフトウェアはMarkdownをサポートしていますが、MultiMarkdownはサポートしていません。これが機能することはどこに記載されていますか?
ta.speot.is 2014

1
@EnricoSusatyoプレーンマークダウンではありませんが、たとえば、
パンドック

2
興味深いことに、GitLabのマークダウン[^footnote]は、公式にドキュメントに追加される
hmijailが辞任者を悼む

1
@hmijailは、OPが求めていたGithubではなく、GitLabの脚注を参照しています。
Devy

1
@Devy、はい、それが私が「GitLabの値下げ」と言った理由です。GitLabのフレーバー実装はGitHubフレーバーに基づいているようであり、一般にMarkdownのフレーバーとその実装は不道徳な混乱であることを考えると、依然として有用である可能性があります。概要:「念のためこれも試してみてください」。
hmijailが辞任者を悼む2018

回答:


218

GitHub Flavored Markdownは脚注をサポートしていませんが、Unicode文字または上付きタグなどを使用して手動で偽造できます<sup>1</sup>

courseもちろん、これは脚注の番号付けを維持する責任があるので、理想的ではありません。ただし、1つまたは2つしかない場合は、それで十分です。


おかげで、他のサイトにクリック可能な脚注リンクがあるのも気に入っていますが、GitHubでこれを行う唯一の方法かもしれません。
Enrico Susatyo 2014

6
角かっこで囲まれた通常の番号を使用することもできます[1]。これは、私の経験ではプレーンテキストの脚注に対してかなり確立された規則です。(まあ、コメントに改行を入れられないのはなぜですか。)[1]つまり、パンドックマンドックの脚注からキャレットを除いたものです。
ギルデンスタン

342

前の回答を少し拡張して、ここでも脚注リンクをクリックできるようにすることができます。最初にこのように下部に脚注を定義します

<a name="myfootnote1">1</a>: Footnote content goes here

次に、このようなドキュメントの他の場所でそれを参照します

<sup>[1](#myfootnote1)</sup>

2
これは良い中立的な答えです。IMOでは、書式設定のための膨張がなくても、意図の明確化が維持されます。
kayleeFrye_onDeck 2016

3
数値以外の参照を使用することで、順次、数値の参照を維持するための、上記の問題を解消する- Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
ランドール・ホイットマン

4
以下の@Matteoの回答のパート2をお見逃しなく。私はこの回答に非常に苦しんでいたので(感謝)、下にスクロールする手間がほとんどありませんでした。。。
wardw 2017年

180

以前の回答をさらに拡張しidて、脚注のリンクに属性を追加できます。

 Bla bla <sup id="a1">[1](#f1)</sup>

次に、脚注内からリンクします。

<b id="f1">1</b> Footnote content here. [↩](#a1)

これにより、脚注のコンテンツの最後に少し追加され、脚注のリンクを含む行に読者が戻ります。


8
上記の@Matteoの応答に小さな修正を追加したため、脚注の呼び出しではnameなく、を使用する必要がありidました。すなわち<p>Bla bla <sup name="a1">[1](#f1)</sup>
oldfartdeveloper

2
@oldfartdeveloperに感謝します。github.com ..のREADMEファイルnameとの両方でid動作するようですが、要点はテストされていません。
Matteo

1
2020年頃にこのQ&Aを見つけた人のために:この回答はGitHubで機能し、PLUSには追加機能があります:return-to-the-footnote-link-you-clicked。私は1つの小さな警告(ここで説明されています)を見つけましたが、これはよくある答えです。
Seamus

13

SuryaとMatteoのソリューションを機能させることができませんでした。たとえば、「(#f1)」はテキストとして表示されただけで、リンクにはなりませんでした。しかし、彼らの解決策は私にわずかに異なる解決策を導きました。(脚注と元の上付き文字へのリンクのフォーマットも少し異なります。)

テキストの本文:

Yadda yadda<a href="#note1" id="note1ref"><sup>1</sup></a>

ドキュメントの最後に:

<a id="note1" href="#note1ref"><sup>1</sup></a>Here is the footnote text.

脚注の上付き文字をクリックすると、元のテキストの上付き文字に戻ります。


面白い。@MatteoがGFMを使用する場所でHTMLを使用しました。私は彼の解決策を機能させることができましたが、少しいじる必要がありました。これはGitHubのレンダリングエンジンの癖だと思いますか?
Seamus

わからない、@ Seamus。私が思い出すと、それを理解しようとしたときに少し試行錯誤がありました。
火星

1
それは賢い解決策です。そして、ええ-それは今日も私たちがいるところです-試行錯誤:)
Seamus

12

正式に文書化されているかどうかはわかりませんが、Githubでフッターノートを作成できます。

  1. 角かっこで囲まれた数字を使用して、フッターリンクを挿入する場所をマークします、IE [1]

  2. 投稿の下部で、番号付きマーカーを参照し、その後にコロンとリンク、IEを付けます。 [1]: http://www.example.com/link1

プレビューすると、投稿の本文に番号付きリンクとしてレンダリングされます。


5
ただし、ドキュメントの最後にリンクのリストは生成されません。ウィキペディアのページのように。
milosa

角括弧の後にコロンが必要ですか?
sAguinaga 2017年

18
これは脚注ではなく、リンクです。
David Moles

ステップ#1はgithubマークダウンのリンクとして機能しませんでした(2018年12月)。
ruhong 2018

7

短いメモの場合、アンカー要素にタイトル属性を指定すると、「ツールチップ」が作成されます。

<a title="Note text goes here."><sup>n</sup></a>

それ以外の場合、より複雑なメモについては、名前付きリンクを手動で維持するのが最善の方法のようです。


1
これは、GitHub Enterprise 2.8の
マークダウン

4

これは私にとってはうまくいきます:

blablabla [<sup>1</sup>](#1)blablabla

脚注:blablablaへの参照 <a class="anchor" id="1"></a>


3

マテオのソリューションの変形を使用しました。私はこれを、JekyllベースのWebサイトのgithubフレーバーマークダウン(gfm)で記述されたRmdファイルで使用していますが、同じRmdファイルを使用して、さまざまなコンテキストでPDFを生成しています。Rmdファイルは数学が多く、数学はウェブサイトのMathJaxで表示されます。したがって、Jekyllで処理され、pandoc-> pdflatexで動作し、MathJaxと互換性のあるgfmで動作するソリューションが必要でした。

Rmdファイルからのスニペット(gfm)

Here is a paragraph with an footnote <span id="a1">[[1]](#f1)</span>.

Footnotes
=========

1. <span id="f1"></span> This is a footnote. [$\hookleftarrow$](#a1)

$\hookleftarrow$私は常にMathJaxを有効にしているので、ラテックスです。これを使用して、PDFに正しく表示されるようにします。インライン演算に脚注を付けると上付き文字が混乱するため、脚注は角括弧で囲みます。

ここでそれは動作しています:https : //eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

これらのメモはRmdのどこにでも置くことができます。末尾にリストを載せているので、技術的には巻末注です。


OPの質問に少し接していますが、最終的には「Jekyll経由で処理され、pandoc-> pdflatexで動作し、MathJaxと互換性のあるgfmで動作するソリューション」が本当に気に入っています。きちんとした例。
boweeb 2018


0

質問はGitHub風味のMarkdownについてですが、2013年の時点で、GitHub はこの機能が組み込まれているAsciiDocをサポートしていることを言及する価値があると思います。.adoc拡張子を付けてファイル名を変更して使用するだけです。

A statement.footnote:[Clarification about this statement.]

A bold statement!footnote:disclaimer[Opinions are my own.]

Another bold statement.footnote:disclaimer[]

ドキュメントと最終結果はこちらです。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.