GitHub 맛 마크 다운에 각주를 추가하는 방법?


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은 (는)

1
@EnricoSusatyo 일반 마크 다운은 아니지만 예를 들어 Pandoc가 지원합니다
mb21

2
흥미롭게도, GitLab의 마크 다운 [^footnote]공식적으로 문서에 추가
hmijail은 사임 자

1
@hmijail 당신은 Github가 아니라 GitLab의 각주를 참조하고 있습니다.
Devy

1
@Devy, 그래, 내가 "GitLab의 마크 다운"이라고 말한 이유이다. GitLab의 풍미 구현이 GitHub 풍미를 기반으로하는 것처럼 보이고 일반적으로 Markdown의 풍미와 구현이 부정한 엉망이라는 점을 감안할 때 여전히 유용 할 수 있습니다. 요약 : "이 경우에도 시도하십시오".
hmijail은 사임 자 애도한다

답변:


218

GitHub Flavored Markdown은 각주를 지원하지 않지만 유니 코드 문자 또는 위첨자 태그 (예 :와 같이)를 사용하여 수동으로 가짜 ¹를 지정할 수 있습니다 <sup>1</sup>.

¹ 물론 각주 번호를 유지해야 할 책임이 있기 때문에 물론 이것은 이상적이지 않습니다. 그러나 하나 또는 두 개만 있으면 합리적으로 잘 작동합니다.


고맙게도 다른 사이트에 클릭 가능한 각주 링크가있는 방법이 마음에 들지만 GitHub 에서이 방법이 유일한 방법 일 수 있습니다.
Enrico Susatyo

6
또한 대괄호로 묶인 일반 숫자를 사용할 수도 있습니다 [1]. 이것은 내 경험에서 평문 각주에 대해 꽤 확립 된 규칙입니다. (댓글에서 줄 바꿈을 할 수없는 이유는 무엇입니까?) [1] 즉, Pandoc Mandoc 각주에서 캐럿을 뺀 것과 같습니다.
Guildenstern

342

이전 답변을 약간 확장하면 각주 링크를 여기에서 클릭 할 수있게 만들 수 있습니다. 먼저 아래처럼 각주를 정의하십시오

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

그런 다음 문서의 다른 곳에서 다음과 같이 참조하십시오

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

2
이것은 좋은 중간 답입니다. IMO 없이 의도를 명확하게 유지 하고 서식을 지정하기에 너무 많은 팽창을 유지합니다.
kayleeFrye_onDeck

3
숫자가 아닌 참조를 사용하면 위에서 언급 한 순차적 인 숫자 참조를 유지하는 문제 Example [[TPL]](#TPL)#### Notes<a name="TPL">[TPL]</a> footnote template
Randall Whitman

4
아래 @Matteo의 답변에서 파트 2를 놓치지 마십시오. 나는이 답변 (고마워)으로 너무 혼란스러워서 스크롤을 거의 귀찮게하지 않았다. . .
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. github.com ..의 README 파일 모두 nameid작동하지만 요점을 테스트하지 않은 것 같습니다 .
Matteo

1
2020 년경에이 Q & A를 발견 한 사람들을 위해 :이 답변은 GitHub, PLUS에서 작동하며 추가 기능 이 있습니다 . 나는 하나의 사소한 경고 (여기 설명)를 발견 했지만 이것이 대답 입니다.
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
그러나 문서 끝에 링크 목록을 생성하지는 않습니다. Wikipedia 페이지와 같습니다.
milosa

대괄호 뒤에 콜론이 있어야합니까?
sAguinaga

17
이것은 각주가 아니며 링크입니다.
David Moles

단계 #1는 github markdown (2018 년 12 월)의 링크로 작동하지 않았습니다.
ruhong

7

짧은 메모의 경우 제목 속성이있는 앵커 요소를 제공하면 "툴팁"이 생성됩니다.

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

그렇지 않으면 더 많은 관련 메모의 경우 가장 좋은 방법은 명명 된 링크를 수동으로 유지하는 것입니다.


1
이것은 GitHub Enterprise 2.8 마크 다운 페이지에서 작동하지 않았습니다.
yegeniy

4

이것은 나를 위해 작동합니다 :

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

각주 : blablabla에 대한 참조 <a class="anchor" id="1"></a>


3

Mateo 솔루션의 변형을 사용했습니다. Jekyll 기반 웹 사이트를 위해 github flavored markdown (gfm)으로 작성된 Rmd 파일에서 이것을 사용하고 있지만 다양한 컨텍스트에서 pdf를 생성하는 데 동일한 Rmd 파일이 사용되고 있습니다. 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

0

라텍스를 사용하지 않고 나를 위해 일한 Eli Holmes대답 은 다음과 같습니다 .

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

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


0

질문은 GitHub 플레이 버드 마크 다운에 관한 것이지만, 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.