Metadata-Version: 2.1
Name: djangocms-equation
Version: 0.2.0
Summary: DjangoCMS plugin to write equations, utilizing KaTeX
Home-page: https://github.com/s-weigand/djangocms-equation
Author: Sebastian Weigand
Author-email: s.weigand.phy@gmail.com
License: Apache Software License 2.0
Project-URL: Documentation, https://djangocms-equation.readthedocs.io/
Project-URL: Source, https://github.com/s-weigand/djangocms-equation
Project-URL: Tracker, https://github.com/s-weigand/djangocms-equation/issues
Description: # 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/master/graph/badge.svg)](https://codecov.io/gh/s-weigand/djangocms-equation)
        [![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)
        
        [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=s-weigand/djangocms-equation)](https://dependabot.com)
        [![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)
        [![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/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](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.
        
        
        # History
        
        ## 0.2.0 (2020-08-09)
        
        - Added 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.
        
Keywords: djangocms-equation django-cms django cms equation latex katex mhchem
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Message Boards
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.5
Description-Content-Type: text/markdown
