Feature footnotes

[lepture]

Footnotes feature. It looks like MultiMarkdown Footnotes Syntax:

Here is some text containing a footnote.[^somesamplefootnote]

[^somesamplefootnote]: Here is the text of the footnote itself.

• http://daringfireball.net/2005/07/footnotes
• https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide#wiki-footnotes
• http://six.pairlist.net/pipermail/markdown-discuss/2005-August/001442.html
• http://six.pairlist.net/pipermail/markdown-discuss/2005-August/001480.html

Related Issue: #27

@chjj Have a review of this patch. I will add test cases soon.

[lepture]

NOTE: this feature is not fully implemented. There are still works to be done.

Here is some text containing a footnote.[^somesamplefootnote]

[^somesamplefootnote]: Here is the text of the footnote itself.
  multi paragraph

  * and even **markdown** markup in a footnote

We need to hack the text value of footnote, just like a list item.

[prashaantt]

Awesome @lepture, I would love this to be finished and pulled in. I began writing this myself a couple of days ago (see also #27 (comment)) but couldn't wrap my head around some of the stuff and gave up the first attempt (JS noob here).

[lepture]

@prashaantt I am not sure that @chjj would agree with this feature. I'd like to implement the unfinished part when @chjj says yes.

[limjiayi]

This would be amazing @lepture and @chjj, I would love for this feature to be added as well.

[lepture]

@prashaantt @contactjiayi I've just created a python fork of markdown. And I am working on footnotes feature in this repo: https://github.com/lepture/mistune

[chjj]

Put up a branch and added a few fixes (footnotes weren't working for two different reasons). I still want to play around with it a bit more.

cc @lepture

[lepture]

@chjj There is still work to do with the footnotes rendering. For example, multiple lines of one footnote. We should unindent each line, and parse the footnote again.

Here is what I did in the Python fork https://github.com/lepture/mistune/blob/master/mistune.py#L691

[chjj]

@lepture, oh, this doesn't handle (unindented) multiparagraph footnotes? I had my own branch written that accomplished this in a really sloppy way, but when I saw your code I assumed you did it a little bit better. I'll push my other branch now.

[lepture]

@chjj I did it in my Python fork. Seems your solution is better, I'll merge it into mine.

[lepture]

@chjj Use footnote_start and footnote_end is a good idea. But I think my way is more elegant now. It looks like parsing list item.

lepture/mistune@a1f925e

[chjj]

I'm totally open to different methods. Like I said, I find my way sloppy. I'll take a look at this in a bit.

[mattly]

Here's the showdown implementation of footnotes if that helps. Quibbles about footnote class and a[rel="footnote"] vs. a.footnoteRef aside, it's almost identical to discount's implementation.

I would love to see this feature in Marked because I want access to the parse tree for other reasons.

[lepture]

@chjj I'll sort out it soon, and send you my patch. I've finished the Python fork, and it works well.

[jonschlinkert]

👍

[hugovincent]

Is this still being worked on or has it been rejected? I'd love to see this feature supported.

[jesselawson]

I'm relying on marked pretty heavily for some web apps in development so this will be something I will be actively creating in the next 24 hours. Stay tuned!

[nournia]

I've used marked.js of this PR as parser of EpicEditor. This results Invalid regular expression error. Is it something wrong with that editor?

[prashaantt]

Hello @chjj, @lepture, do you guys have any update on this?

[hugovincent]

Hi @chjj, @lepture, any plans to merge this into master? I'm using the feature-footnotes branch successfully.

[prashaantt]

@hugovincent I agree it works in the basic scenario, but not when the footnote text is itself written in Markdown — i.e. MD-formatted links and formatting in the footnote definition don't get parsed into HTML.

[prashaantt]

In case anybody's interested, I just pushed an update to my clone of the feature-footnotes branch that sacrifices performance and breaks marked's linearity but does get indented multi-para footnotes working correctly with inline Markdown parsing. It basically works, but is still nowhere near the full functionality as given here.

I tried @chjj's footnotes branch that attempts to do this better, but ran into rendering issues. I would be delighted if it could be finished officially once @chjj can spare some time.

[jeffmcneill]

Not sure if this will help, but here are several implementations:

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

[afischer]

Does it look like this will be implemented?

[marr]

Needs rebase. Fwiw, I'd consider multimarkdown(mmd) for their footnote support, but their node package isn't compiling for me. mnichols/node-mmd#4

Hope to see footnotes added to marked soon!

[joshbruce]

Closing as stale, missing tests, and merge conflicts.