search

markdown-it / markdown-it-footnote

Footnotes plugin for markdown-it markdown parser
https://markdown-it.github.io/
MIT License
210 stars 59 forks source link

Syntax for inline footnotes #32

Closed ejfox closed 5 years ago

ejfox commented 5 years ago

Right now the syntax for inline footnotes in markdown-it-footnote as follows:

Here is an inline note.^[Inlines notes are easier to write, since
you don't have to pick an identifier and move down to type the
note.]

However referencing some other resources markdown parsers, we find that there are a variety of implementations. I first discovered this because I was creating my posts in the markdown editor IA Writer and the footnotes rendered properly in the preview, but not when rendered through markdown-it.

Here are some other implementations I've dug up:

IA writer Some text with a footnote[^This is the footnote itself.].

MultiMarkdown Here is another footnote.[^This is the footnote itself]

Pandoc Here is an inline note.^[Inlines notes are easier to write, since you don't have to pick an identifier and move down to type the note.]

rephrase.net PHP-Markdown I met Jim [^](My old college roommate) at the station.

Would it be worth it to support all of these implementations? If so, where might someone get started on implementing that?

Thank you!

puzrin commented 5 years ago

Since there are no unified spec, and commonmark still not defined this extension, there are no plans to change this package. Anyone, interested in oner syntax, can implement it's own plugin. markdown-it allow change almost everything and make you independent on author's opinion.