question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add footnote syntax?

See original GitHub issue

As discussed in #31 it appears that people are for a footnote syntax, as implemented in some flavours of Markdown (see Extended Syntax):

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

Can we come to a decision on this, bearing in mind

  1. that this syntax extension is not strictly compliant with CommonMark, as discussed here
  2. That (as with any syntax extension) this would incur some parsing performance cost (although probably minimal)

Note these footnotes would be inherently auto-numbered, as can be tried in the VS Code standard preview (GitHub markdown does not support footnotes)

image

paging @choldgraf @mmcky @jstac @akhmerov @najuzilu

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:22 (22 by maintainers)

github_iconTop GitHub Comments

3reactions
chrisjsewellcommented, Mar 2, 2020

What are your thoughts on inline footnotes? On the one hand, RMarkdown already supports this,

I’d say no because its pretty non-standard and could just as easily be handled in a simple extension:

{foot}`this is a footnote to be auto-numbered`

rather than introducing more complexity into the parser, leading to a slower parse and more potential bugs.

2reactions
choldgrafcommented, Mar 4, 2020

yeah, well it would probably just directly go from [^this syntax] to the docutils node for a footnote (at least, I think there’s a special node for this). If we wanted to add an in-line role for a short-hand, it might be something like {ft}`This is my footnote text`

Read more comments on GitHub >

github_iconTop Results From Across the Web

Insert footnotes and endnotes - Microsoft Support
On the References tab, select Insert Footnote or Insert Endnote. On the References tab choose Insert Footnote. Enter what you want in the...
Read more >
What Are Footnotes? | Guide with Word Instructions - Scribbr
Select the “References” tab at the top, and then select “Insert Footnote.” Type whatever text you want into the footnote that appears. Inserting...
Read more >
What Are Footnotes and How Do You Use Them? - Scribendi
Footnotes are notes that are placed at the end of a page and used to reference parts of the text (generally using superscript...
Read more >
Footnotes - Overleaf, Online LaTeX Editor
An online LaTeX editor that's easy to use. No installation, real-time collaboration, version control, hundreds of LaTeX templates, and more.
Read more >
How to Add/Set Footnotes in LaTex - Resurchify
In this section, we will learn how to add footnotes in LaTeX. It is very simple and straightforward to add a footnote in...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found