Skip to content

docs: document the BBCode, Embed, Emoji and Markdown extensions - #654

Merged
imorland merged 2 commits into
flarum:mainfrom
karl-bullock:docs-format-and-embed-extensions
Oct 11, 2026
Merged

imorland merged 2 commits into
flarum:mainfrom
karl-bullock:docs-format-and-embed-extensions

Conversation

@karl-bullock

@karl-bullock karl-bullock commented Oct 10, 2026 •

Copy link
Copy Markdown
Member

Adds admin pages for four bundled extensions that had none, as agreed with Ian: BBCode, Embed, Emoji and Markdown. Each is added to the Bundled Extensions sidebar in alphabetical order.

  • Markdown: the supported syntax (including superscript, subscript and both spoiler forms), the toolbar, the Ctrl/⌘+B and Ctrl/⌘+I shortcuts, and list continuation on Enter. Notes that tables aren't supported and that code highlighting loads from jsDelivr.
  • BBCode: all supported tags with examples.
  • Emoji: the : autocomplete and toolbar button, the emoticon list, and the CDN mirror setting. Notes that a typed :rocket: is never converted.
  • Embed: enabling it, the embed URL format, the host-page snippet with iframe-resizer v4, and what readers see. Also covers logging in from inside the embed: it works on the same site, but cross-site embeds stay logged out unless cookie.samesite is set to none.
  • Every page: what happens to existing posts when the extension is disabled. For Markdown, BBCode and Emoji, formatting stops showing and comes back when the extension is re-enabled.

Everything was checked on a stock 2.0.0 forum: posts with every syntax, rendered HTML read back through the API, each extension disabled and re-enabled, and a discussion embedded in a host page with iframe-resizer.

Not included:

The composer.json docs links are in flarum/framework#5168.

@imorland imorland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Karl. I added the images. Good to go!

@imorland
imorland merged commit a1d25ac into flarum:main Oct 11, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants