matpompili/flarum-latex

Provides LaTeX functionalitty to Flarum

Installs: 252

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 2

Language:JavaScript

Type:flarum-extension

v1.0.0 2015-12-05 18:51 UTC

This package is not auto-updated.

Last update: 2020-08-07 20:01:38 UTC


README

flarum-LaTeX is a Flarum extension to support LaTeX, using KaTeX.

Flarum is a free, open-source forum software built with PHP and Mithril.js.

KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.

Features

With flarum-Latex you can render LaTeX mathematical expressions inside your forum just by typing them, in the same way you would do your TeX document.

It supports:

  • Inline expressions like $\sin\theta$, as well as
  • Display expressions, such as $$\frac{\cos(kx)}{\cos(x)}$$.

It also doesn't mess up with Markdown and BBCode extensions, so you can use all of them at the same time.

This is how the previous paragraph will look like:

Imgur

Install

The only way to get flarum-latex is with composer: in your flarum folder run

composer require matpompili/flarum-latex

Then enable it you administration panel. Done!

Usage

You can write mathematical expressions in the composer and when the post is submitted it will be rendered correctly, even if the preview is messed up by Markdown, BBCode and emojis.

Tip

If you want to actually show the LaTeX code, you must use Markdown in the following way:

This is an expression I don't want to render
```
$$\cos(\pi) + 1 = 0$$
```
While this is going to be rendered: $yes$