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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file djangocms-equation-0.2.4.tar.gz.

File metadata

  • Download URL: djangocms-equation-0.2.4.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for djangocms-equation-0.2.4.tar.gz
Algorithm Hash digest
SHA256 0f92dbec46563a5a0e9d95e442a0a9239bb184e6f0bba69989588b5a1d79f5e7
MD5 fb76f21039f744fefa8215d76bcec4fa
BLAKE2b-256 75e384b32d2b1112c04acef8163cf1820743e3ee6483fb56a6f156677a35c2df

See more details on using hashes here.

File details

Details for the file djangocms_equation-0.2.4-py2.py3-none-any.whl.

File metadata

  • Download URL: djangocms_equation-0.2.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for djangocms_equation-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1b6dd6fb5c8ce028eb233039fb8a7419160c4c212cb5f83231eb59bcba7daf44
MD5 ee2c2fb8ce29509a275267f059ae71c8
BLAKE2b-256 e96ab2a6e376322404780d4917ff6a2af0ab2e1ee2f029fb5367f973918772fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page