Shortcode documentation available? Like to know available parameters

Hielkio

Hi folks,

Anyone here who could point me to a place where available (by default) shortcodes are documented?
I'd like to (for example) show image captions. I tried some default BBCode parameters, but they don't seem to work.

Maybe a bit off-topic, but it extends my question, so I'll give it a try. I guess there must be a way to add your own shortcodes, is this correct? If so, how could I achieve such?

Thanks all!

clarkwinkelmann

The technical documentation of all bbcode tags is available here https://s9etextformatter.readthedocs.io/Plugins/BBCodes/Add_from_the_repository/

Not all of those bbcodes are enabled by default in Flarum. You can see which ones are enabled in https://github.com/flarum/bbcode/blob/master/extend.php

Other bbcodes can be enabled by calling the same code as the flarum/bbcode extension in your root extend.php file together with a bbcode name from the first link.

Adding custom bbcode or shortcodes is possible using the Formatter extender together with the TextFormatter API. For an example of a very simple custom bbcode you can see how this extension is implemented https://github.com/clarkwinkelmann/flarum-ext-comicsans/blob/master/extend.php