Bagaimana cara menambahkan catatan kaki ke Markdown rasa GitHub?

273

Saya hanya mencoba menambahkan catatan kaki di GitHub Gist saya , tetapi tidak berhasil:

Some long sentence. [^footnote]

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

Saya mengikuti panduan ini dan saya pikir saya tidak melakukan kesalahan. Bisakah seseorang menunjukkan kesalahan saya?

markdown github-flavored-markdown multimarkdown

— Enrico Susatyo
sumber

1

fletcher.github.io/peg-multimarkdown Catatan: Saat ini, perangkat lunak wiki Github mendukung Markdown, tetapi tidak MultiMarkdown Di mana didokumentasikan bahwa ini akan berfungsi?

— ta.speot.is

1

@EnricoSusatyo Tidak dalam penurunan harga biasa, tetapi misalnya Pandoc mendukungnya

— mb21

2

Menariknya, penurunan harga GitLab mendukung [^footnote]sintaksis, bahkan sebelum ditambahkan secara resmi ke dalam dokumentasi

— hmijail berduka pada orang-orang yang mengundurkan diri pada

1

@hmijail Anda mengacu pada catatan kaki GitLab, bukan Github seperti yang diminta OP.

— Devy

1

@ Evy, ya, itu sebabnya saya mengatakan "penurunan harga GitLab". Masih bisa bermanfaat, mengingat implementasi citarasa GitLab tampaknya didasarkan pada citarasa GitHub, dan bahwa secara umum penurunan harga, rasa dan implementasinya adalah kekacauan yang tidak suci. Ringkasan: "kalau-kalau coba ini juga".

— hmijail meratapi orang-orang yang mengundurkan diri

218

GitHub Flavoured Markdown tidak mendukung catatan kaki, tetapi Anda dapat memalsunya secara manual¹ dengan karakter Unicode atau tag superskrip, misalnya 1.

¹ Tentu saja ini tidak ideal, karena Anda sekarang bertanggung jawab untuk menjaga penomoran catatan kaki Anda. Ini bekerja dengan cukup baik jika Anda hanya memiliki satu atau dua.

— Chris
sumber

Terima kasih, saya juga suka bagaimana situs lain memiliki tautan catatan kaki yang dapat diklik, tapi saya kira ini mungkin satu-satunya cara untuk melakukannya di GitHub.

— Enrico Susatyo

6

Anda juga dapat menggunakan angka biasa yang dilampirkan dalam tanda kurung [1], yang merupakan konvensi yang cukup mapan untuk catatan kaki plaintext dalam pengalaman saya. (Astaga kenapa aku tidak bisa membuat jeda baris dalam komentar.) [1] Yaitu seperti catatan kaki Pandoc Mandoc dikurangi tanda sisipan.

— Guildenstern

342

Memperluas sedikit jawaban sebelumnya, Anda dapat membuat tautan catatan kaki dapat diklik di sini juga. Pertama, tentukan catatan kaki di bagian bawah seperti ini

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

Kemudian rujuk di tempat lain dalam dokumen seperti ini

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

— suryasankar
sumber

2

Ini adalah jawaban yang bagus. Itu mempertahankan kejelasan maksud tanpa, IMO , terlalu banyak mengasapi untuk memformat.

— kayleeFrye_onDeck

3

Menggunakan referensi non-numerik menyingkirkan masalah yang disebutkan di atas dalam mempertahankan referensi numerik berurutan - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template

— Randall Whitman

4

Jangan lewatkan Bagian 2 dalam jawaban @ Matteo di bawah ini. Saya sangat kesal dengan jawaban ini (terima kasih) sehingga saya hampir tidak mau gulir ke bawah. . .

— wardw

180

Memperluas jawaban sebelumnya lebih jauh, Anda dapat menambahkan idatribut ke tautan catatan kaki Anda:

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

Kemudian dari dalam catatan kaki, tautkan kembali ke sana.

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

Ini akan menambahkan sedikit ↩di akhir konten catatan kaki Anda, yang membawa pembaca Anda kembali ke baris yang berisi tautan catatan kaki.

— Matteo
sumber

8

Menambahkan koreksi kecil ke respons @ Matteo di atas, saya harus menggunakan namealih-alih iddalam panggilan ke catatan kaki. Yaitu Bla bla [1](#f1)

— oldfartdeveloper

2

Terima kasih @oldfartdeveloper. Tampaknya keduanya namedan idberfungsi untuk file README di github.com .. meskipun belum menguji intisari.

— Matteo

1

Bagi mereka yang menemukan T&J ini di sekitar tahun 2020: Jawaban ini berfungsi di GitHub, PLUS memiliki fitur tambahan: kembalilah ke tautan catatan kaki-yang diklik . Saya telah menemukan satu peringatan kecil (dijelaskan di sini) , tetapi ini adalah jawaban afaic.

— Seamus

13

Saya tidak bisa mendapatkan solusi Surya dan Matteo untuk bekerja. Misalnya, "(# f1)" baru saja ditampilkan sebagai teks, dan tidak menjadi tautan. Namun, solusi mereka membawa saya ke solusi yang sedikit berbeda. (Saya juga memformat catatan kaki dan tautan kembali ke naskah asli sedikit berbeda.)

Di badan teks:

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

Di akhir dokumen:

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

Mengklik pada superskrip dalam catatan kaki kembali ke superskrip dalam teks asli.

— Mars
sumber

Menarik. Anda telah menggunakan HTML di mana @Matteo menggunakan GFM. Saya bisa mendapatkan solusinya untuk bekerja, tetapi perlu sedikit mengutak-atik . Apakah Anda pikir ini adalah kekhasan dalam mesin rendering GitHub?

— Seamus

Saya tidak tahu, @ Seamus. Seingat saya, ada sedikit trial and error ketika saya mencoba mencari tahu.

— Mars

1

Ini solusi cerdas. Dan ya - itu masih di mana kita hari ini - coba-coba :)

— Seamus

12

Meskipun saya tidak tahu apakah ini secara resmi didokumentasikan di mana saja, Anda dapat membuat catatan kaki di Github.

Tandai tempat di mana Anda ingin menyisipkan tautan footer dengan nomor yang disertakan dalam tanda kurung, IE [1]
Di bagian bawah posting, buat referensi dari penanda bernomor dan diikuti oleh titik dua dan tautan, yaitu IE [1]: http://www.example.com/link1

Dan setelah Anda melihat pratinjau, itu akan diberikan sebagai tautan bernomor di badan pos.

— Devy
sumber

5

Ini tidak menghasilkan daftar tautan di akhir dokumen Anda. Seperti di halaman Wikipedia.

— milosa

haruskah ada titik dua setelah tanda kurung?

— sAguinaga

18

Ini bukan catatan kaki, ini tautan.

— David Moles

langkah #1tidak berfungsi sebagai tautan pada penurunan harga github (Des 2018).

— ruhong

7

Untuk catatan singkat, memberikan elemen jangkar dengan atribut judul menciptakan "tooltip".

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

Kalau tidak, untuk catatan yang lebih terlibat, sepertinya taruhan terbaik Anda adalah mempertahankan tautan yang diberi nama secara manual.

— Rich Traube
sumber

1

Ini tidak berfungsi di halaman penurunan harga GitHub Enterprise 2.8

— yegeniy

4

Ini bekerja untuk saya:

blablabla [1](#1) blablabla

catatan kaki: referensi ke blablabla <a class="anchor" id="1"></a>

— aerijman
sumber

3

Saya menggunakan varian dari solusi Mateo. Saya menggunakan ini dalam file Rmd yang ditulis dalam github flavored markdown (gfm) untuk situs web Jekyll tetapi file Rmd yang sama digunakan untuk menghasilkan pdf dalam berbagai konteks. File Rmd adalah matematika yang berat dan matematika ditampilkan dengan MathJax di situs web. Jadi saya membutuhkan solusi yang bekerja dengan gfm yang diproses melalui Jekyll, bekerja dengan pandoc-> pdflatex, dan kompatibel dengan MathJax.

cuplikan dari file Rmd (yaitu 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$ adalah lateks, yang berfungsi untuk saya karena saya selalu mengaktifkan MathJax. Saya menggunakannya untuk memastikan itu muncul dengan benar di pdf saya. Saya meletakkan catatan kaki saya di dalam kurung siku karena superscript membingungkan jika saya menaruh catatan kaki pada beberapa matematika inline.

Ini dia sedang beraksi: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Catatan ini dapat diletakkan di mana saja di Rmd. Saya memasukkan daftar di bagian akhir sehingga secara teknis catatan akhir.

— Eli Holmes
sumber

Agak tangensial terhadap pertanyaan OP tetapi akhirnya saya sangat suka "solusi Anda yang bekerja dengan gfm yang diproses melalui Jekyll, bekerja dengan pandoc-> pdflatex, dan kompatibel dengan MathJax". Contoh rapi.

— boweeb

0

Berikut adalah variasi Eli Holmes ' jawaban yang bekerja untuk saya tanpa menggunakan latex:

Text<span id="a1">[¹](#1)</span>

<span id="1">¹</span> Footnote.[⏎](#a1)<br>

Contoh

— Scott Gardner
sumber

0

Meskipun pertanyaannya adalah tentang GitHub Markdown, saya pikir itu layak disebutkan bahwa pada 2013 , GitHub mendukung AsciiDoc yang memiliki fitur bawaan ini. Anda hanya perlu mengganti nama file Anda dengan .adocekstensi dan menggunakan:

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

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

Another bold statement.footnote:disclaimer[]

Dokumentasi beserta hasil akhirnya ada di sini .

— Doron Behar
sumber