GitHub aromalı Markdown'a dipnotlar nasıl eklenir?

273

Sadece GitHub Gist'e dipnot eklemeye çalışıyorum , ancak çalışmıyor:

Some long sentence. [^footnote]

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

Bu kılavuzu takip ediyorum ve yanlış bir şey yaptığımı sanmıyorum. Birisi benim hatamı gösterebilir mi?

markdown github-flavored-markdown multimarkdown

— Enrico Susatyo
kaynak

1

fletcher.github.io/peg-multimarkdown Not: Şu anda, Github wiki yazılımı Markdown'u destekliyor ancak MultiMarkdown'u destekleyemiyor Bunun işe yarayacağı nerede belgeleniyor?

— ta.speot.is

1

@EnricoSusatyo Düz markdownda değil, örneğin Pandoc bunu destekliyor

— mb21

2

İlginç bir şekilde, GitLab'ın işaretlemesi, belgelere resmi olarak eklenmeden[^footnote] önce bile sözdizimini destekliyor

— hmijail,

1

@hmijail, OP'nin sorduğu Github'a değil, GitLab'ın dipnotuna atıfta bulunuyorsunuz.

— Devy

1

@Devy, evet, bu yüzden "GitLab'ın markdown" dedim. GitLab'ın lezzet uygulamasının GitHub lezzetine dayandığı ve genel olarak Markdown'da lezzetlerinin ve uygulamalarının kutsal olmayan bir karmaşa olduğu göz önüne alındığında yine de faydalı olabilir. Özet: "her ihtimale karşı da deneyin".

— hmijail resignees

218

GitHub Aromalı Markdown dipnotları desteklemez, ancak Unicode karakterleri veya üst simge etiketleriyle manuel olarak sahte yapabilirsiniz 1.

CourseTabii ki bu ideal değil, çünkü artık dipnotlarınızın numaralandırmasını korumaktan sorumlusunuz. Yine de, sadece bir veya iki tane varsa, oldukça iyi çalışır.

— Chris
kaynak

Teşekkürler, ayrıca diğer sitelerin tıklanabilir dipnot bağlantılarına sahip olmasını da seviyorum, ancak sanırım GitHub'da bunu yapmanın tek yolu olabilir.

— Enrico Susatyo

6

Ayrıca, deneyimlerime göre düz metin dipnotları için oldukça köklü bir kural olan köşeli parantezler [1] içine alınmış normal numaraları da kullanabilirsiniz. (Tanrım darnit neden yorumlarda satır sonu yapamıyorum.) [1] Pandoc Mandoc'un dipnotları eksi şapka gibi.

— Guildenstern

342

Önceki yanıtta biraz genişleyerek, dipnot bağlantılarını burada tıklanabilir hale getirebilirsiniz. İlk önce dipnotu aşağıdaki gibi tanımlayın

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

Sonra belgede bunun gibi başka bir yerde referans alın

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

— suryasankar
kaynak

2

Bu güzel bir orta yol cevabı. Biçimlendirme için çok fazla şişkinlik olmadan, IMO'suz niyetin netliğini korur .

— kayleeFrye_onDeck

3

Sayısal olmayan referansların kullanılması, yukarıda belirtilen sıralı sayısal referansların korunması konusunu ortadan kaldırır - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template

— Randall Whitman

4

Aşağıda Matteo'nın cevabındaki 2.Bölümü kaçırmayın. Neredeyse aşağı kaydırmak için uğraşmadı bu cevap (teşekkürler) ile chuffed. . .

— 17'de

180

Önceki yanıtları daha da genişleterek iddipnotunuzun bağlantısına bir özellik ekleyebilirsiniz :

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

Sonra dipnotun içinden geri bağlantı kurun.

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

Bu, ↩dipnotunuzun içeriğinin sonuna biraz ekler , bu da okuyucularınızı dipnotun bağlantısını içeren satıra geri götürür.

— Matteo
kaynak

8

Yukarıdaki @ Matteo'nun cevabına küçük bir düzeltme ekleyerek dipnot çağrısı nameyerine kullanmak zorunda kaldım id. Ie Bla bla [1](#f1)

— oldfartdeveloper

2

Teşekkürler @oldfartdeveloper. Hem görünüyor nameve idgithub.com README dosyaları için çalışma .. gerçi GİST test etmedim.

— Matteo

1

Bu soru ve cevapları yaklaşık 2020'de bulanlar için: Bu yanıt GitHub, PLUS üzerinde çalışır ve ek özelliğe sahiptir: tıkladığınız dipnot bağlantısına dön . (Burada açıklanmıştır) küçük bir uyarı bulduk , ama bu cevap afaic.

— Seamus

13

Surya'nın ve Matteo'nun çözümlerini çalıştıramadım. Örneğin, "(# f1)" kısa bir süre metin olarak gösterildi ve bağlantı haline gelmedi. Ancak çözümleri beni biraz farklı bir çözüme götürdü. (Ayrıca dipnotu ve orijinal üst tablonun bağlantısını biraz farklı biçimlendirdim.)

Metnin gövdesinde:

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

Belgenin sonunda:

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

Dipnottaki üst simgeye tıklandığında orijinal metindeki üst simgeye dönülür.

— Mars
kaynak

İlginç. @Matteo'nun GFM kullandığı HTML kullandınız. Çözümünü çalıştırabildim, ama biraz uğraşmak gerekiyordu . Sizce bu GitHub'ın render motorunda bir tuhaflık mı?

— Seamus

Hiçbir fikrim yok, @Seamus. Hatırladığım gibi, anlamaya çalışırken biraz deneme yanılma yapıldı.

— Mars

1

Bu akıllıca bir çözüm. Ve evet - bugün hala

— buradayız

12

Resmi olarak herhangi bir yerde belgelenmiş olup olmadığının farkında olmasam da, Github'da altbilgi notları yapabilirsiniz.

Altbilgi bağlantısını eklemek istediğiniz yeri köşeli parantez içine alınmış bir numarayla işaretleyin, IE [1]
Gönderinin alt kısmında, numaralı işaretleyiciye bir referans yapın ve ardından bir iki nokta üst üste ve bağlantı, IE [1]: http://www.example.com/link1

Ve bir kez önizleme, yazı gövdesinde numaralı bağlantılar olarak işlenecektir.

— Devy
kaynak

5

Bu, belgenizin sonunda bir bağlantı listesi oluşturmaz. Wikipedia sayfalarında olduğu gibi.

— milosa

köşeli parantezlerden sonra iki nokta üst üste olmalı mı?

— sAguinaga

17

Bu bir dipnot değil, bu bir link.

— David Moles

adımı #1github markdown'da bir bağlantı olarak çalışmadı (Aralık 2018).

— ruhong

7

Kısa notlar için, bir başlık özniteliğine sahip bir bağlantı öğesi sağlamak bir "araç ipucu" oluşturur.

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

Aksi takdirde, daha fazla not için, en iyi bahsinizin adlandırılmış bağlantıları manuel olarak tutması gibi görünüyor.

— Zengin Traube
kaynak

1

Bu bir GitHub Enterprise 2.8 etiketleme sayfasında

— çalışmadı

4

Bu benim için çalışıyor:

blablabla [1](#1)blablabla

dipnotlar: blablabla referansı <a class="anchor" id="1"></a>

— aerijman
kaynak

3

Mateo'nun çözümünün bir çeşidini kullandım. Bunu Jekyll destekli bir web sitesi için github aromalı markdown (gfm) ile yazılmış Rmd dosyalarında kullanıyorum, ancak aynı Rmd dosyaları çeşitli bağlamlarda pdfs üretmek için kullanılıyor. Rmd dosyaları matematik ağır ve matematik MathJax ile web sitesinde görüntülenir. Bu yüzden Jekyll ile işlenen, pandoc-> pdflatex ile çalışan ve MathJax ile uyumlu olan gfm ile çalışan bir çözüme ihtiyacım vardı.

sndpet, Rmd dosyasından (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$ her zaman MathJax'ı etkinleştirdiğim için benim için çalışan lateks. Bunu benim pdfs doğru görünmesini sağlamak için kullanın. Dipnotlarımı köşeli parantez içine aldım çünkü satır içi matematikte dipnot koyarsam üst simge kafa karıştırıcı.

İşte burada: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Bu notlar Rmd'de herhangi bir yere konabilir. Sonunda bir listeye koyuyorum, bu yüzden teknik olarak son notlar.

— Eli Holmes
kaynak

OP sorusuna hafif teğet ama sonuçta "Jekyll aracılığıyla işlenen gfm ile çalışan, pandoc-> pdflatex ile çalışan ve MathJax ile uyumlu olan çözümünüzü" gerçekten çok seviyorum. Düzgün bir örnek.

— boweeb

0

İşte varyasyonu olan Eli Holmes'un ' cevabı lateks kullanmadan benim için çalıştı:

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

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

Misal

— Scott Gardner
kaynak

0

Soru GitHub aromalı Markdown ile ilgili olmasına rağmen, 2013'ten beri GitHub'ın bu özellik yerleşik olan AsciiDoc'u desteklediğini belirtmek gerekir . Yalnızca dosyanızı bir .adocuzantıyla yeniden adlandırmanız ve kullanmanız gerekir:

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

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

Another bold statement.footnote:disclaimer[]

Nihai sonuçla birlikte belgeler burada .

— Doron Behar
kaynak