Como adicionar notas de rodapé ao Markdown com sabor do GitHub?

273

Estou apenas tentando adicionar notas de rodapé no meu GitHub Gist , mas não funciona:

Some long sentence. [^footnote]

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

Estou seguindo este guia e acho que não estou fazendo nada de errado. Alguém pode apontar o meu erro?

Enrico Susatyo
fonte
1
fletcher.github.io/peg-multimarkdown Nota: Atualmente, o software wiki do Github suporta o Markdown, mas não o MultiMarkdown. Onde está documentado que isso vai funcionar?
ta.speot.is
1
@EnricoSusatyo Não em markdown simples, mas, por exemplo suportes Pandoc-lo
MB21
2
Curiosamente, a marcação do GitLab suporta a [^footnote]sintaxe, mesmo antes de ser oficialmente adicionada à documentação
hmijail lamenta os demitidos em
1
@hmijail, você está se referindo à nota de rodapé do GitLab, não ao Github, como o OP estava pedindo.
Devy
1
@ Devy, sim, é por isso que eu disse "remarcação do GitLab". Ainda pode ser útil, dado que a implementação de sabor do GitLab parece basear-se no sabor do GitHub e que, em geral, o Markdown, seus sabores e implementações são uma bagunça profana. Resumo: "apenas no caso de tentar isso também".
hmijail lamenta renunciados em 9/0318

Respostas:

218

O Markdown com sabor do GitHub não suporta notas de rodapé, mas você pode falsificá-lo manualmente¹ com caracteres Unicode ou tags sobrescritas, por exemplo <sup>1</sup>.

CourseClaro que isso não é o ideal, pois agora você é responsável por manter a numeração das notas de rodapé. Funciona razoavelmente bem se você tiver apenas um ou dois.

Chris
fonte
Obrigado, também gosto de como outros sites têm links de notas de rodapé clicáveis, mas acho que essa pode ser a única maneira de fazer isso no GitHub.
Enrico Susatyo
6
Você também pode usar números regulares entre colchetes [1], que é uma convenção bastante estabelecida para notas de rodapé em texto simples na minha experiência. (Nossa, por que não consigo fazer quebras de linha nos comentários.) [1] Ou seja, como as notas de rodapé de Pandoc Mandoc menos o sinal de intercalação.
Guildenstern
342

Expandindo um pouco a resposta anterior, você também pode clicar nos links das notas de rodapé aqui. Primeiro defina a nota de rodapé na parte inferior como esta

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

Em seguida, referencie-o em algum outro local do documento como este

<sup>[1](#myfootnote1)</sup>
suryasankar
fonte
2
Esta é uma boa resposta intermediária. Mantém esclarecer a intenção sem, na IMO , inchaço demais para formatação.
kayleeFrye_onDeck
3
Usando referências não numéricos elimina a questão de manter referências numéricas sequenciais acima mencionada - Example [[TPL]](#TPL)... #### Notes...<a name="TPL">[TPL]</a> footnote template
Randall Whitman
4
Não perca a Parte 2 da resposta de @ Matteo abaixo. Fiquei tão entusiasmado com esta resposta (obrigado) que quase não me incomodei em rolar para baixo. . .
wardw
180

Expandindo ainda mais as respostas anteriores, você pode adicionar um idatributo ao link da nota de rodapé:

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

Em seguida, de dentro da nota de rodapé, vincule-o novamente.

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

Isso adicionará um pouco ao final do conteúdo da nota de rodapé, o que levará seus leitores de volta à linha que contém o link da nota de rodapé.

Matteo
fonte
8
Adicionando uma pequena correção à resposta de @ Matteo acima, eu tive que usar em namevez de idna chamada para a nota de rodapé. Bla bla <sup name="a1">[1](#f1)</sup>
Ou
2
Obrigado @oldfartdeveloper. Parece que ambos namee o idtrabalho para arquivos README no github.com .. ainda não testaram o essencial.
Matteo
1
Para quem encontra essas perguntas e respostas por volta de 2020: Esta resposta funciona no GitHub, PLUS, e possui o recurso adicional: retornar ao link da nota de rodapé que você clicou . Eu encontrei uma ressalva menor (explicada aqui) , mas esta é a resposta afaic.
Seamus
13

Não consegui que as soluções de Surya e Matteo funcionassem. Por exemplo, "(# f1)" foi exibido apenas como texto e não se tornou um link. No entanto, suas soluções me levaram a uma solução ligeiramente diferente. (Também formatei a nota de rodapé e o link de volta ao sobrescrito original de maneira um pouco diferente.)

No corpo do texto:

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

No final do documento:

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

Clicar no sobrescrito na nota de rodapé retorna ao sobrescrito no texto original.

Marte
fonte
Interessante. Você usou HTML onde @Matteo usou GFM. Consegui fazer com que a solução dele funcionasse, mas isso exigia um pouco de brincadeira . Você acha que isso é uma peculiaridade no mecanismo de renderização do GitHub?
Seamus
Não faço ideia, @Seamus. Pelo que me lembro, houve um pouco de tentativa e erro quando eu estava tentando descobrir.
Mars
1
É uma solução inteligente. E sim - ainda é onde estamos hoje - tentativa e erro :)
Seamus
12

Embora eu não saiba se está oficialmente documentado em algum lugar, você pode fazer anotações no rodapé no Github.

  1. Marque o local em que deseja inserir o link do rodapé com um número entre colchetes, IE [1]

  2. Na parte inferior da postagem, faça uma referência ao marcador numerado e seguido por dois pontos e o link, IE [1]: http://www.example.com/link1

E depois de visualizá-lo, ele será renderizado como links numerados no corpo da postagem.

Devy
fonte
5
Isso não gera uma lista de links no final do seu documento. Como nas páginas da Wikipedia.
milosa 29/09/16
deve haver dois pontos depois dos colchetes?
precisa saber é o seguinte
18
Esta não é uma nota de rodapé, é um link.
David Moles
A etapa #1não funcionou como um link na remarcação do github (dez de 2018).
ruhong
7

Para anotações curtas, fornecer um elemento âncora com um atributo title cria uma "dica de ferramenta".

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

Caso contrário, para notas mais envolvidas, parece que sua melhor aposta é manter os links nomeados manualmente.

Rich Traube
fonte
1
Isto não funcionou em uma página 2.8 remarcação GitHub Empresa
yegeniy
4

Isso funciona para mim:

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

notas de rodapé: referência a blablabla <a class="anchor" id="1"></a>

aerijman
fonte
3

Eu usei uma variante da solução de Mateo. Eu estou usando isso em arquivos Rmd escritos em github flavored markdown (gfm) para um site movido a Jekyll, mas os mesmos arquivos Rmd estão sendo usados ​​para produzir pdfs em vários contextos. Os arquivos Rmd são pesados ​​em matemática e a matemática é exibida com o MathJax no site. Então, eu precisava de uma solução que funcione com o gfm que seja processada via Jekyll, que funcione com o pandoc-> pdflatex e que seja compatível com o MathJax.

trecho do arquivo Rmd (que é 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$é látex, o que funciona para mim, pois sempre tenho o MathJax ativado. Eu uso isso para garantir que ele apareça corretamente nos meus PDFs. Coloco minhas notas de rodapé entre colchetes porque o sobrescrito é confuso se eu estiver colocando uma nota de rodapé em alguma matemática embutida.

Aqui está em ação: https://eeholmes.github.io/posts/2016-5-18-FI-recursion-1/

Essas notas podem ser colocadas em qualquer lugar no Rmd. Estou colocando uma lista no final para que sejam notas técnicas.

Eli Holmes
fonte
Um pouco tangível à pergunta do OP, mas no final das contas eu realmente gosto da sua "solução que funciona com o gfm que é processada via Jekyll, funciona com pandoc-> pdflatex e é compatível com o MathJax". Exemplo puro.
boweeb
0

Aqui está uma variação de Eli Holmes ' resposta que funcionou para mim sem o uso de látex:

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

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

Exemplo

Scott Gardner
fonte
0

Embora a pergunta seja sobre o Markdown com sabor do GitHub, acho que vale a pena mencionar que, a partir de 2013 , o GitHub suporta o AsciiDoc, que tem esse recurso embutido. Você só precisa renomear seu arquivo com uma .adocextensão e usar:

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

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

Another bold statement.footnote:disclaimer[]

A documentação e o resultado final estão aqui .

Doron Behar
fonte