Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/s-weigand/djangocms-equation

DjangoCMS plugin to write equations, utilizing KaTeX
https://github.com/s-weigand/djangocms-equation

django-cms djangocms-plugin equation equation-latex katex

Last synced: 3 months ago
JSON representation

DjangoCMS plugin to write equations, utilizing KaTeX

Awesome Lists containing this project

README 

        
# djangocms-equation



[![PyPi Version](https://img.shields.io/pypi/v/djangocms-equation.svg)](https://pypi.org/project/djangocms-equation/)

[![Supported Python Versions](https://img.shields.io/pypi/pyversions/djangocms-equation.svg)](https://pypi.org/project/djangocms-equation/)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)



[![Test Status](https://github.com/s-weigand/djangocms-equation/workflows/Tests/badge.svg)](https://github.com/s-weigand/djangocms-equation/actions)

[![Documentation Status](https://readthedocs.org/projects/djangocms-equation/badge/?version=latest)](https://djangocms-equation.readthedocs.io/en/latest/?badge=latest)

[![Code Coverage](https://codecov.io/gh/s-weigand/djangocms-equation/branch/main/graph/badge.svg)](https://codecov.io/gh/s-weigand/djangocms-equation)

[![Docstring Coverage](https://raw.githubusercontent.com/s-weigand/djangocms-equation/main/docs/_static/interrogate_badge.svg)](https://github.com/econchick/interrogate)

[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/s-weigand/djangocms-equation)



[![Codacy code quality](https://api.codacy.com/project/badge/Grade/f3c0be01f67b43b082810a0d86a79b4d)](https://www.codacy.com/manual/s.weigand.phy/djangocms-equation?utm_source=github.com&utm_medium=referral&utm_content=s-weigand/djangocms-equation&utm_campaign=Badge_Grade)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/s-weigand/djangocms-equation.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/s-weigand/djangocms-equation/alerts/)

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/s-weigand/djangocms-equation.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/s-weigand/djangocms-equation/context:python)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/s-weigand/djangocms-equation.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/s-weigand/djangocms-equation/context:javascript)



[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=s-weigand/djangocms-equation)](https://dependabot.com)

[![Code style Python: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Code style TypeScript: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)



DjangoCMS plugin to write equations, utilizing KaTeX



![](https://github.com/s-weigand/djangocms-equation/blob/main/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](https://mhchem.github.io/MathJax-mhchem/)

- Configurable allowing of copying of equation LaTeX code



## Installation



Install the plugin from PyPi



```bash

$ pip install djangocms-equation

```



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

project.



```python

"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.



```python

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`.



```python

"KATEX_EQUATION_SETTINGS" = {"allow_copy": True}

```



## Credits



This package was created with

[Cookiecutter](https://github.com/cookiecutter/cookiecutter) and the

[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)

project template.