atom / markdown-preview

📝 Markdown preview in Atom
MIT License
1.23k stars 356 forks source link

Footnote Support #153

Open jeffmcneill opened 9 years ago

jeffmcneill commented 9 years ago

Support footnotes as implemented in Multimarkdown, Marked2, PHP Markdown Extra, and/or Pandoc.

This uses the following syntax.[^arbitrary-footnote-name-or-number] Perhaps more text here.Then after double-return:

[^arbitrary-footnote-name-or-number]:Footnote text (which could include links.

Note: There is $20 in bounty at Bountysource for this enhancement: https://www.bountysource.com/issues/6326578-footnote-support

dreamalligator commented 9 years ago

:+1: I'd love this too.

jbrains commented 9 years ago

:+1: In the meantime, I continue to use Marked to copy/paste the final HTML. Not a terrible workaround.

jeffmcneill commented 9 years ago

Stackedit Editor https://stackedit-beta.herokuapp.com/ also displays footnotes, but the point is to have footnote support in Atom Markdown preview. To be honest I've never understood why Marked, a non-free, non-open-source tool, is popular. Displaying markedup previews is the whole point of Markdown to begin with, as well as the point of this package, as far as I can tell.

jbrains commented 9 years ago

How about making the Markdown processor configurable? It solves the problem, opens up other features, and encourages untangling some of the code. What would the disadvantages be?

jeffmcneill commented 9 years ago

Note that this pandoc preview plugin does the trick https://github.com/lierdakil/markdown-preview-pandoc though there are issues with the PATH for invoking Pandoc

vegetableman commented 9 years ago

There is a pending PR for this on marked https://github.com/chjj/marked/pull/351 which this project depends on.

cyranodev commented 8 years ago

I've been unable to install the pandoc preview package. No clue how to find a workaround on that.

rugk commented 8 years ago

:+1:

cm3 commented 8 years ago

:+1: to @jbrains 's idea making the Markdown processor configurable

martindale commented 7 years ago

:+1:, thank you for creating this issue. Subscribed!

jeffmcneill commented 7 years ago

Markdown Extra is a good implementation, and I think the one that Pandoc is based on:

https://michelf.ca/projects/php-markdown/extra/#footnotes

Here is an example (using the old Markdown Extra on WordPress):

[^kingdom-of-angles]: The Kingdom of the Angles

[^clans]: Clans, Families and Septs, by Sir Crispin Agnew of Lochnaw Bt.

And then these display at the bottom of the page like this:

https://mcneill.io/memoir/livelihood/

dreamalligator commented 7 years ago

according to the PR @vegetableman linked, it looks stalled in that other repo. We'll need to reboot that feature if it is still the blocking dependency.

jeffmcneill commented 7 years ago

I am referring to a BountySource effort, rather than trying to fix Pandoc. https://www.bountysource.com/issues/6326578-footnote-support