Discourse Footnote

[Discourse]

This plugin is now bundled with Discourse core and is enabled by default. There is no need to install the plugin separately.

	Summary	Discourse Footnote allows users to create markdown footnotes in posts.
	Repository Link	https://github.com/discourse/discourse-footnote
	Install Guide	How to install plugins in Discourse

As this is an official plugin maintained by the Discourse team, support, bug, ux, and feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Enabling Footnote

The Footnote plugin is default enabled but can be disabled/enabled from the admin/plugins page:

Features

Once enabled, you can add footnotes to your posts by typing them in like this:

A sentence that needs a footnote. ^[The footnote] 
Another sentence that needs a footnote. ^[The second footnote]

Or like this:

A sentence that needs a footnote. [^1] 
Another sentence that needs a footnote. [^2]

[^1]: The footnote
[^2]: The second footnote

You can mix and match both styles within a post, as well as use non-numbered anchors.

There are two ways to display the footnotes, controlled by the display footnotes inline admin setting:

Non-inline:

Inline:

A sentence that needs a footnote^[1]
Another sentence that needs a footnote^[2]

The inline versions are both Quote and mobile-friendly.

Settings

Name	Description
enable markdown footnotes	enable footnote markdown on this site
display footnotes inline	enable inline expansion of footnotes

Hosted by us? This plugin is available on all of our hosting tiers Footnote | Discourse - Civilized Discussion

Development History

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

---

1. The footnote ↩︎

2. The second footnote ↩︎

Last edited by @JammyDodger 2024-06-03T21:59:06Z

Check document

Perform check on document:

[Kayla]

@sam

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. 

Just a heads up that the extension does not seem to all allow for the regular markdown for footnotes using [^1]. I do not get formatted footnotes unless I use the “inline” formatting, like so:

@sam

You can also use “inline” footnotes — not the inline expansion, but the note itself. Like this:

More wise sayings ^[Lincoln, or Einstein, or something]

Enabling footnotes using inline footnote formatting results in auto-numbered footnotes which then appear below the post together, while also-enabling inline expansion enables the ellipsis tooltip-like experience with no footnotes appearing below the post. If you have the inline expansion option enabled, your post preview window will look like traditional numbered footnotes, but you’ll see the inline expanded effect after publishing.

I appreciate the automatically-numbered footnotes using the inline formatting, it just took me a few tries to figure out how I should actually format the markdown and which options would get them to behave as desired. Hopefully this comment helps someone else avoid the same confusion.

Edit to add: The inline expansion option is how your footnotes will appear on mobile, regardless of whether that option is enabled (for desktop also).

[denvergeeks]

Recipe for allowing your users to create inline popup content using this Discourse Footnote Plugin:

Combine this Plugin with the Composer Footnote Button Theme Component ^[1] (it provides a button in the Composer/Editor to create footnotes)

You can put anything inside the popups, including HTML.

Examples:

Text ^[2]

---

Text and Image Upload ^[3]

---

HTML Content ^[4]

---

1. (install them both) ↩︎

2. Plain text here. ↩︎

3. Text and Image Upload
   ↩︎

4. 

   When you encounter an open source group for the first time, it may be a bewildering experience. Whether posting to a mailing list for the first time, blogging about the project you’re taking on or hanging out on an IRC channel - the way people interact, and what they expect from each other is pretty different than in classroom or with friends and family.

   
   

   Openness and Sharing

   Open source communication can vary a lot. A core value held in common is that sharing code is good. Regardless of license, language or indentation style, open source developers create, share and modify source code together.

   ↩︎

[jrgong]

Does the footnote plugin also work on public pages? In my specific case I want it NOT to work on public pages and only be visible in the regular topic view (to use it for internal notes etc)

[denvergeeks]

@jrgong – no…

Adding DiscoTOC to Published Pages

at the moment page publishing is not designed to support theme components or anything using plugin api and especially decorateCooked. Not saying this is impossible, but we didn’t work on it and at this point I dont know if we will.

However, there is this alternative approach for which I’m in the process of developing a Theme Component… over on Github.

[pfaffman (Jay Pfaffman)]

Looks like this got moved to core 17 hours ago.

I’ll let someone else update this appropriately.

Translation missing: en.The discourse-footnote plugin has been integrated into discourse core. Please remove the plugin from your app.yml and rebuild your container.

FEATURE: Bundle discourse-footnote plugin into core

[LoveMCJ]

After moving to core,

I deleted the plugin from app.yml and ran ./launcher rebuild app,

but the settings remain on the plugin page. Is it okay to just leave it like this?

[JammyDodger]

That’s the new one. Here’s a shot of both for comparison:

[LoveMCJ]

@JammyDodger

That’s the new one. Here’s a shot of both for comparison:

That’s a really nice sound! Thank you for sharing.

[blake (Blake Erickson)]

@pfaffman

I’ll let someone else update this appropriately.

Translation missing: en.The discourse-footnote...

Thanks for mentioning this, I just pushed a fix.

[pfaffman (Jay Pfaffman)]

The other issue is that you don’t need to install the plugin anymore, and if you have installed it, you need not to include that git clone in your yml file.

[JammyDodger]

I was too slow in updating the topic with the new info and you beat me to it.

I’ll add my bit now anyway…

---

Discourse Footnote has now been bundled with Discourse core, so this plugin will no longer need to be installed separately.

If you self-host you should see some information on your dashboard about removing it from your app.yml.

Hosted by us? This change will not affect you in any way. You can continue to enjoy this plugin and not worry about a thing.

[pfaffman (Jay Pfaffman)]

Yeah. Sorry about that.

That’s awesome! I knew you had a plan. I should have just waited, as the other thing I pointed out was, in fact, a problem that was, in fact, dealt with by someone else, and I should have just been patient since I knew you were going to hangle it. (And it’s so pretty, too!).

It’s still been less than 24 hours, so, you know, that’s pretty good too.

Thanks.