the-turk / flarum-mathren
TeX math rendering for your forum.
Installs: 2 777
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 3
Forks: 4
Open Issues: 1
Language:JavaScript
Type:flarum-extension
Requires
- flarum/core: >=1.2.0
This package is auto-updated.
Last update: 2024-12-06 03:09:37 UTC
README
An extension that handles TeX math rendering for your Flarum forum.
Click to view settings screenshot
Features
- Based on KaTeX (the fastest math typesetting library on the web).
- Supports AsciiMath syntax.
- Display expressions as an inline or a block element.
- Compatible with Markdown and BBCode.
- Copy any expression's source code to the clipboard.
- Integration with
flarum/mentionsextension so you can quote expressions with selection. - Works on preview mode.
Installation
composer require the-turk/flarum-mathren
Updating
composer update the-turk/flarum-mathren php flarum cache:clear
Usage
Enable the extension.
Block Expressions displayMode: true
Wrap your TeX code with [math] and [/math] or your custom delimiters.
[math]\int_{-\infty}^\infty\hat\xi\,e^{2\pi i\xi x}\,d\xi[/math]
Block expressions will be wrapped with .mathren-block class.
Inline Expressions displayMode: false
Wrap your TeX code with [imath] and [/imath] or your custom delimiters.
Lorem ipsum dolor [imath]\varDelta = b^2-4ac[/imath] sit amet.
Inline expressions will be wrapped with .mathren-inline class.
Wrap your expression with `backticks` or code tag to skip rendering.