วิธีเพิ่มเชิงอรรถลงใน Markdown ที่แต่งกลิ่นของ GitHub?


273

ฉันแค่พยายามเพิ่มเชิงอรรถในGitHub Gist ของฉันแต่มันไม่ทำงาน:

Some long sentence. [^footnote]

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

ฉันทำตามคำแนะนำนี้และฉันไม่คิดว่าฉันทำอะไรผิด มีคนชี้ให้เห็นความผิดพลาดของฉันได้ไหม?


1
fletcher.github.io/peg-multimarkdown หมายเหตุ: ปัจจุบันซอฟต์แวร์วิกิ Github รองรับ Markdown แต่ไม่ใช่ MultiMarkdownมันมีเอกสารว่าจะใช้งานที่ไหน
ta.speot.is

1
@EnricoSusatyo ไม่ได้อยู่ใน markdown ธรรมดา แต่ตัวอย่างเช่นPandoc รองรับมัน
mb21

2
สิ่งที่น่าสนใจการทำเครื่องหมายของ GitLab สนับสนุน[^footnote]ไวยากรณ์ก่อนที่มันจะถูกเพิ่มเข้าไปในเอกสารอย่างเป็นทางการ
hmijail mourns ลาออก

1
@hmijail คุณอ้างถึงเชิงอรรถของ GitLab ไม่ใช่ Github ตามที่ OP ร้องขอ
Devy

1
@Devy ใช่นั่นคือเหตุผลที่ฉันพูดว่า "markit ของ GitLab" อาจยังมีประโยชน์เนื่องจากการใช้รสชาติของ GitLab ดูเหมือนว่าจะขึ้นอยู่กับรสชาติของ GitHub และโดยทั่วไปแล้ว Markdown รสชาติและการใช้งานของมันเป็นระเบียบที่ไม่บริสุทธิ์ สรุป: "ลองทำเช่นนี้ด้วย"
hmijail mourns ลาออกจาก

คำตอบ:


218

GitHub Flavoured Markdown ไม่รองรับเชิงอรรถ แต่คุณสามารถปลอมด้วยตนเองได้ด้วยอักขระ Unicode หรือแท็กตัวยกเช่น <sup>1</sup>หรือแท็กยกตัวอย่างเช่น

¹แน่นอนว่าสิ่งนี้ไม่เหมาะอย่างยิ่งเนื่องจากคุณมีหน้าที่รับผิดชอบในการรักษาจำนวนเชิงอรรถ มันทำงานได้ดีพอสมควรถ้าคุณมีเพียงหนึ่งหรือสอง


ขอบคุณฉันชอบไซต์อื่น ๆ ที่มีลิงก์เชิงอรรถที่คลิกได้ แต่ฉันเดาว่านี่อาจเป็นวิธีเดียวใน GitHub
Enrico Susatyo

6
คุณยังสามารถใช้ตัวเลขปกติที่อยู่ในวงเล็บเหลี่ยม [1] ซึ่งเป็นแบบแผนที่กำหนดขึ้นมาอย่างสวยงามสำหรับเชิงอรรถเชิงลึกในประสบการณ์ของฉัน (Gosh darnit ทำไมฉันไม่สามารถแบ่งบรรทัดในความคิดเห็น) [1] เช่น Pandoc Mandoc เชิงอรรถลบเครื่องหมายคาเร็ต
Guildenstern

342

ขยายคำตอบก่อนหน้าเล็กน้อยคุณสามารถทำให้ลิงก์เชิงอรรถคลิกได้ที่นี่เช่นกัน ก่อนอื่นให้นิยามเชิงอรรถที่ด้านล่างเช่นนี้

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

จากนั้นอ้างอิงที่อื่นในเอกสารเช่นนี้

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

2
นี่เป็นคำตอบที่ดีในระดับกลาง มันยังคงความกระจ่างของเจตนาโดยไม่มีIMO , bloat มากเกินไปสำหรับการจัดรูปแบบ
kayleeFrye_onDeck

3
การใช้การอ้างอิงที่ไม่ใช่ตัวเลขจะช่วยแก้ปัญหาดังกล่าวข้างต้นในการรักษาการอ้างอิงที่เป็นตัวเลข - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
Randall Whitman

4
อย่าพลาดส่วนที่ 2 ในคำตอบของ @ Matteo ด้านล่าง ฉันรู้สึกแย่มากกับคำตอบนี้ (ขอบคุณ) ที่ฉันแทบไม่ต้องกังวลที่จะเลื่อนลงมา . .
Wardw

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 ดูเหมือนว่าทั้งคู่nameและidทำงานกับไฟล์ README บน github.com .. ยังไม่ได้ทดสอบจีสต์
Matteo

1
สำหรับผู้ที่พบ Q & A ในราว 2020: คำตอบนี้ทำงานบน GitHub รวมทั้งจะมีคุณสมบัติเพิ่มเติม: ผลตอบแทน to-เชิงอรรถการเชื่อมโยงที่คุณคลิก ฉันได้พบข้อแม้เล็กน้อยหนึ่งข้อ (อธิบายที่นี่)แต่นี่เป็นคำตอบที่แปลก
เชมัส

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.

การคลิกที่ตัวยกในเชิงอรรถจะกลับไปเป็นตัวยกในข้อความต้นฉบับ


น่าสนใจ คุณใช้ HTML โดยที่ @Matteo ใช้ GFM ผมสามารถที่จะได้รับการแก้ปัญหาของเขาในการทำงาน แต่ก็ต้องมีบิตของการเล่นซอ คุณคิดว่านี่เป็นสิ่งที่แปลกประหลาดในเครื่องมือเรนเดอร์ของ GitHub หรือไม่?
เชมัส

ฉันไม่มีความคิด @Seamus ในขณะที่ฉันจำได้ว่ามีการทดลองและข้อผิดพลาดเล็กน้อยเมื่อฉันพยายามคิดออก
ดาวอังคาร

1
มันเป็นทางออกที่ฉลาด และใช่ - นั่นคือสิ่งที่เรายังคงอยู่ในวันนี้ - ลองผิดลองถูก :)
เชมัส

12

แม้ว่าฉันไม่ทราบว่ามีการบันทึกอย่างเป็นทางการทุกที่หรือไม่คุณสามารถทำบันทึกส่วนท้ายใน Github

  1. ทำเครื่องหมายสถานที่ที่คุณต้องการแทรกลิงก์ส่วนท้ายด้วยหมายเลขที่อยู่ในวงเล็บเหลี่ยม IE [1]

  2. ที่ด้านล่างของโพสต์ให้อ้างอิงเครื่องหมายที่มีหมายเลขและตามด้วยเครื่องหมายโคลอนและลิงก์คือ IE [1]: http://www.example.com/link1

และเมื่อคุณดูตัวอย่างแล้วจะมีการแสดงผลเป็นลิงก์หมายเลขในเนื้อหาของโพสต์


5
สิ่งนี้จะไม่สร้างรายการลิงก์ในตอนท้ายของเอกสารของคุณ กดไลค์บนหน้า Wikipedia
milosa

ควรมีเครื่องหมายทวิภาคหลังวงเล็บเหลี่ยมหรือไม่
sAguinaga

17
นี่ไม่ใช่เชิงอรรถนี่คือลิงก์
David Moles

ขั้นตอน#1ไม่ทำงานเป็นลิงก์ในมาร์คอัป GitHub (ธันวาคม 2018)
ruhong

7

สำหรับโน้ตสั้น ๆ การจัดให้มีองค์ประกอบสมอพร้อมกับแอตทริบิวต์ title สร้าง "คำแนะนำเครื่องมือ"

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

มิฉะนั้นสำหรับบันทึกเพิ่มเติมที่เกี่ยวข้องดูเหมือนว่าทางออกที่ดีที่สุดของคุณคือการรักษาลิงก์ที่มีชื่อด้วยตนเอง


1
สิ่งนี้ไม่สามารถใช้งานได้ในหน้า markdown ของ GitHub Enterprise 2.8
yegeniy

4

สิ่งนี้ใช้ได้กับฉัน:

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

เชิงอรรถ: อ้างอิงถึง blablabla <a class="anchor" id="1"></a>


3

ฉันใช้วิธีการแก้ปัญหาต่าง ๆ ของ Mateo ฉันใช้สิ่งนี้ในไฟล์ Rmd ที่เขียนด้วย github flavored markdown (gfm) สำหรับเว็บไซต์ขับเคลื่อน Jekyll แต่ไฟล์ Rmd เดียวกันนั้นถูกใช้เพื่อสร้างไฟล์ PDF ในบริบทต่างๆ ไฟล์ Rmd นั้นหนักมากและคณิตศาสตร์จะแสดงพร้อมกับ MathJax บนเว็บไซต์ ดังนั้นฉันต้องการโซลูชันที่ทำงานกับ gfm ที่ประมวลผลผ่าน Jekyll ทำงานกับ pandoc-> pdflatex และเข้ากันได้กับ MathJax

ตัวอย่างจากไฟล์ 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 เล็กน้อย แต่ท้ายที่สุดฉันชอบ "โซลูชันที่ทำงานกับ gfm ที่ประมวลผลผ่าน Jekyll ทำงานกับ pandoc-> pdflatex และเข้ากันได้กับ MathJax" ตัวอย่างเรียบร้อย
boweeb


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.