djangocms-equation

PyPi Version Supported Python Versions License

Test Status Documentation Status Code Coverage This project is using Percy.io for visual regression testing.

Dependabot Status Codacy code quality Code style Python: black Code style TypeScript: prettier

DjangoCMS plugin to write equations, utilizing KaTeX

https://github.com/s-weigand/djangocms-equation/blob/master/demo.gif?raw=true

Features

  • Enables the use of LaTeX for equations with django-cms

  • Live editing of LaTeX Code, via KaTeX

  • Out of the box support for mhchem

  • Configurable allowing of copying of equation LaTeX code

Installation

Install the plugin from PyPi

$ pip install djangocms-equation

Add the plugin to the installed apps in the settings.py of your django-cms project.

"INSTALLED_APPS": [..., "djangocms_equation"]

For the Equations to be properly displayed in djangocms-text-ckeditor, while edit them, you need to add the css file to the allowed files of ckeditor. To do this simply add the following lines to your settings.py of your django-cms project.

CKEDITOR_SETTINGS = {
    "contentsCss": ["/static/djangocms_equation/css/change_form_template.css"]
}

Note:

The equations might not be rendered properly in ckeditor-windows, when they are added the first time. This can be fixed by saving the text plugin or having another equation on the page.

To allow copying of equations LaTeX code, add the following line to your settings.py.

"KATEX_EQUATION_SETTINGS" = {"allow_copy": True}

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.