Discourse footnote

Summary: The discourse footnote plugin allows you to create markdown footnotes in your posts.

image

:link: GitHub: https://github.com/discourse/discourse-footnote
:arrow_right: Install: Follow the plugin installation guide.

Features

Footnotes have been discussed as an optional CommonMark extension for a while:

The general consensus is that the extension should allow for syntax such as:

some deep thought who needs a reference[^1]

[^1]: Here's the reference. 

Discourse footnote re-packages the footnote markdown.it extension by @Vitaly as a Discourse plugin.

It supports both, single line and multi paragraph footnotes.

So, for example, this works.

We are our choices. [^sartre]

A lot of interesting words

He really said it. [^sartre]

[^sartre]: We are our choices.
Sartre, some time
some day
in the past

In a multi site environment each site can enable or disable the extension with the enable_markdown_footnotes setting.

Additionally you can either enable or disable “inline” expansion with display_footnotes_inline

Screenshots

This is how stuff looks without inline expansion:

image

This is how stuff looks with inline expansion:

image

Inline expansion is “quote” friendly and mobile friendly.

CHANGELOG

TODO

51 Likes

I’ve suggested moving this plugin from being an exclusive-to-enterprise plugin to being a standard plugin, for the Discourse-hosted instances: Move footnotes to a standard plugin

3 Likes

When I am creating footnotes in the editor on my site, they show up like this in the preview:

image

but like this

in the post. Is this… on purpose? Is it configurable behavior?

It would also be nice to have the ability to opt for numbered footnotes, in different styles, like [1] or 1 or , or even the traditional sequence *, †, ‡, §, ‖, ¶, or commonly used * ** *** ****.

1 Like

The OP says the one is inline expansion and can be controlled by this setting:


Sidenote: Isn’t ‘I think, therefore I am’ Descartes?

2 Likes

Ah, thanks. I totally missed that even though it’s right there .

What I really want, though, is the numbered behavior but inline expansion, and possibly with an expandable “footnotes” thing at the bottom.

2 Likes