Provides plugin to render formulae in django CMS
Project description
djangocms-katex
Provides a django CMS plugin to render formulae using KaTeX and its mhchem extension.
The plugin can display formulae either inline or in display mode. It is text-enabled and you can add equations to rich text fields of djangocms-text-ckeditor.
The plugin form has a preview functionality that either shows the typed formula. Errors are shown in red.
Installation
For a manual install:
-
run
pip install djangocms-katex
-
add the following entries to your
INSTALLED_APPS
:"djangocms_katex",
-
run
python manage.py migrate
The Code plugin uses the ace code editor which is loaded from a CDN by default.
If you want the ace code editor to be served from static files, please use
djangocms-katex[static-ace]
instead of djangocms-katex
in your
requirements or with pip. Make the static files for the ace code editor available
to your project by adding djangocms_static_ace
to your project's
INSTALLED_APPS
.
djangocms-text-ckeditor's inline functionality might interfere with KaTeX's layout.
To ensure a great editing experience deactivate it if you use djangocms-katex by
removing TEXT_INLINE_EDITING = True
from your settings.py
file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for djangocms_katex-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a707438723f438b6f5f19c2514b5c989ff88854c7957f466fdc87ca5e331c0a4 |
|
MD5 | 2cd8daaa4209349a6d8a00218a7afcf3 |
|
BLAKE2b-256 | e1251c05f80db7b006ce0b269049b3eb839e862b6472c627d6c8deabec795d4e |