mjbvz / vscode-markdown-footnotes

Adds [^1] footnote syntax support to VS Code's built-in Markdown preview

Adds [^1] footnote syntax support to VS Code's built-in Markdown preview

Features

• Adds support for [^1] syntax to VS Code's built-in markdown preview

vscode-markdown-footnotes's Issues

[Feature request] notebook markdown cells

Hi, would it be possible to extend it to notebook cells which are in Markdown ?

Footnotes in lists shouldn't render in a separate segment.

A snippet of code from one of my documents (https://gitlab.com/rokejulianlockhart/rokejulianlockhart/-/blob/524e74887d24ce94fd9dde79aeeea43f153b5759/%09%60%7Btitle:%20%22Entities%22,%09id:%20%22s1gvg2%22%7D%60%7B.JSON5%7D.dir/%09%60%7Bname:%20%7Bshort:%20%22Beedell.RokeJulianLockhart%22,%09long:%20%7Bthird:%20%22Beedell%22,%09first:%20%22Roke%22%7D%7D,%09id:%20%22s1gvgt%22%7D%60%7B.JSON5%7D.dir/%09%60%7Btitle:%20%22Documents%22,%09id:%20%22s4aaax%22%7D%60%7B.JSON5%7D.dir/%09%60%7Btitle:%20%22Apparel%22,%09id:%20%22s4jy92%22%7D%60%7B.JSON5%7D.txt.MD#L418-422):

Spooky protist at a distance. [^PathogenicProtists]

1.	<details open> <summary> <h2> Bibliography </h2> </summary>

	1.	[^PathogenicProtists]: https://courses.lumenlearning.com/wm-biology2/chapter/pathogenic-protists/#:~:text=A%20small%20number,of%20food%20crops

	</details>

renders as

Spooky protist at a distance. ¹

1. Bibliography

Footnotes

1. https://courses.lumenlearning.com/wm-biology2/chapter/pathogenic-protists/#:~:text=A%20small%20number,of%20food%20crops ↩

Incorrect rendering of a repeated footnote

Some text[^f1]

Some more text[^f1]

[^f1]: footnote 1

The Markdown above is rendered as:

Some text^[1]

Some more text^[1:1]

On GitHub, the rendering is correct:

Some text¹

Some more text¹

Footnotes

1. footnote 1 ↩ ↩²

v0.1.0 doesn't work

since getting the update yesterday, footnotes render as inline text, exactly as if this extension were uninstalled

I'm running VSCode 1.73.1 on Windows 11

not sure if it's relevant, but your Mermaid extension, as well as a Katex extension do continue to work, implying it's not a VSCode change

suggestion

Hi,

footnote is useful for some kinds of writing, however we have to input [^ft] ， [^ft]: and jump to the location of footnotes manually.

I wish you could support this function:

• when we enter a hotkey, [^ftNum] is created in the cursor location,
• then jump to a corresponding [^ftNum]: in the end of the document.

Looking forward to your reply.

go to definition / go to usage

Hello there,

for long documents it would be really nice if you could

• go to definition on the [^ft] marker to go the actualy footnote text
• do the reverse by if you are in the actualy footnote and cycle through all usages.

I will just put it here for later reference and might implement it myself at a later point in time if nobody else has.

Thanks for your extension by the way :)

Add Icon

Extension takes 12s to activate

After cloning a repo, this extension takes 12s to activate (total initial extension activation time was 30s, so this extension accounted for over a third of that time). Since it looks like it doesn't declare a specific activation event I'm wondering if we can defer its activation or reduce the amount of work that happens in its activate method.

Error: Cannot read property 'type' of undefined

After installed the extension the VSCode preview for markdown not work.

In the Windows Log appears:

[renderer1] [error] Cannot read property 'type' of undefined: TypeError: Cannot read property 'type' of undefined
	at Array.footnote_tail (C:\Users\foo\.vscode\extensions\bierner.markdown-footnotes-0.0.4\node_modules\markdown-it-footnote\index.js:335:49)
	at Core.process (c:\Program Files\Microsoft VS Code\resources\app\extensions\markdown-language-features\node_modules\markdown-it\lib\parser_core.js:51:13)
	at MarkdownIt.parse (c:\Program Files\Microsoft VS Code\resources\app\extensions\markdown-language-features\node_modules\markdown-it\lib\index.js:523:13)
	at MarkdownEngine.parse (c:\Program Files\Microsoft VS Code\resources\app\extensions\markdown-language-features\out\markdownEngine.js:88:23)
	at <anonymous>

I have try to search the cause but without success.

• VSCode version: 1.27.2
• Node.js version: 8.9.3
• OS: Windows 10 64 bit

No preview in VS Code 1.29.1

Since updating to the newest Version of VS Code (1.29.1), no preview can be displayed for markdown-files, when markdown-footnotes is enabled.

This is true with and without other markdown-extensions like Markdown All in One enabled.

Functionality is not exported when saving to HTML

Not sure if this bug comes from this extension or from Marldown All In One.
When you do CTRL+SHIFT+P -> 'Marldown All In One: Print current document to HTML' the footnotes are not exported in a way that is consistent with the preview.
Eg. They are displayed in the HTML "as-is" in source form.

See also: zhang-gh/vscode-markdown#605

Footnotes that start on the next line don't render as footnotes

Example from GitHub:

[^1]: My reference.
[^2]: Every new line should be prefixed with 2 spaces.  
  This allows you to have a footnote with multiple lines.
[^note]:
    Named footnotes will still render with numbers instead of the text but allow easier identification and linking.  
    This footnote also has been made with a different syntax using 4 spaces for new lines.

The third example ([^note]) doesn't render as a footnote.
Same when indenting by 2 spaces.

Please consider publishing the extension in open-vsx.org

This would make it more accessible for people using VSCodium and for some other Editors.
https://github.com/eclipse/openvsx/wiki/Publishing-Extensions