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.

Please support markdown footnotes [^1] [^note]

See original GitHub issue

Feature request

What problem does this feature solve?

To cite the Markdown Guide:

Footnotes allow you to add notes and references without cluttering the body of the document.

For instance, in docsified software manuals this would help with structuring the information given better: useful background information can be given and clearly linked with the main text, yet without making the main text too full of details.

What does the proposed API look like?

According to the Markdown Guide:

A footnote[^1]

[^1] This is a footnote.

How should this be implemented in your opinion?

I’m not sure I understand this question in the context of this particular feature request.

One thing I notice it that docify authors might want to have control over the placement of footnotes: either at the end of a “page” or, alternatively, before the next same-level heading.

Are you willing to work on this yourself?

Unfortunately, I completely lack the necessary Javascript and markdown parsing experience to code this.

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

2reactions
sy-recordscommented, Aug 21, 2021

We use marked, is “footnote” supported in marked.js?

if you want, you can put them all at the end of your document, sort of like footnotes.

Here’s an example of reference links in action:

I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].

  [1]: http://google.com/        "Google"
  [2]: http://search.yahoo.com/  "Yahoo Search"
  [3]: http://search.msn.com/    "MSN Search"

Using the implicit link name shortcut, you could instead write:

I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].

  [google]: http://google.com/        "Google"
  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
  [msn]:    http://search.msn.com/    "MSN Search"

I get 10 times more traffic from Google than from Yahoo or MSN.

see https://github.com/markedjs/marked/blob/master/test/specs/original/markdown_documentation_syntax.md#span-elements

1reaction
sy-recordscommented, Mar 27, 2022

Hi there. Thanks @onedge, I have published it as a plugin that can be directly referenced.

<script src="//cdn.jsdelivr.net/npm/@sy-records/docsify-footnotes/lib/index.min.js"></script>

Read more comments on GitHub >

github_iconTop Results From Across the Web

Footnotes now supported in Markdown fields - The GitHub Blog
You can now use footnote syntax in any Markdown field! Footnotes are displayed as superscript links. Click them to jump to their referenced ......
Read more >
Markdown footnotes? - Meta Stack Exchange
2) Adding a new/citation or removing an existing one in amongst existing ones is error-prone; all instances of all later notes need to...
Read more >
How to add footnotes to GitHub-flavoured Markdown?
Expanding a little bit on the previous answer, you can make the footnote links clickable here as well. First define the footnote at...
Read more >
Footnotes in Markdown - Javatpoint
Footnotes allow us to specify the notes or reference without affecting the document appearance. It is represented as a symbol in the form...
Read more >
Every USEFUL Markdown Syntax That I Use in Obsidian
This video is all about markdown in obsidian. I'm going over all of the useful markdown syntax that I use in obsidian ranging...
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