Skip to main content

DjangoCMS plugin to write equations, utilizing KaTeX

Project description

djangocms-equation

PyPi Version Supported Python Versions License

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

Codacy code quality Total alerts Language grade: Python Language grade: JavaScript

Dependabot Status Code style Python: black Code style TypeScript: prettier

DjangoCMS plugin to write equations, utilizing KaTeX

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.

History

0.2.4 (2021-05-11)

  • Upgraded KaTeX to 0.13.9
  • Updated javascript dependencies to fix security issues

0.2.3 (2021-05-04)

  • Upgraded KaTeX to 0.13.5

0.2.2 (2021-03-29)

  • Added official python 3.9 support
  • Upgraded KaTeX to 0.13.0

0.2.1 (2020-08-09)

  • Added official python 3.8 support

0.2.0 (2020-08-09)

  • Upgraded KaTeX to 0.12.0
  • Dropped support for Django 2.0

0.1.1 (2020-02-20)

  • Added project urls and removed conda badge

0.1.0 (2020-02-20)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djangocms-equation-0.2.4.tar.gz (1.4 MB view hashes)

Uploaded source

Built Distribution

djangocms_equation-0.2.4-py2.py3-none-any.whl (1.4 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page