Please support markdown footnotes [^1] [^note]
See original GitHub issueFeature 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:
- Created 2 years ago
- Comments:5 (2 by maintainers)
Top GitHub Comments
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:
Using the implicit link name shortcut, you could instead write:
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
Hi there. Thanks @onedge, I have published it as a plugin that can be directly referenced.