Skip to main content

Provides plugin to render formulae in django CMS

Project description

djangocms-katex

Provides a django CMS plugin to render formulae using KaTeX and its mhchem extension.

The plugin can display formulae either inline or in display mode. It is text-enabled and you can add equations to rich text fields of djangocms-text-ckeditor.

The plugin form has a preview functionality that either shows the typed formula. Errors are shown in red.

Example screenshot

Installation

For a manual install:

  • run pip install djangocms-katex

  • add the following entries to your INSTALLED_APPS:

        "djangocms_katex",
    
  • run python manage.py migrate

The Code plugin uses the ace code editor which is loaded from a CDN by default. If you want the ace code editor to be served from static files, please use djangocms-katex[static-ace] instead of djangocms-katex in your requirements or with pip. Make the static files for the ace code editor available to your project by adding djangocms_static_ace to your project's INSTALLED_APPS.

djangocms-text-ckeditor's inline functionality might interfere with KaTeX's layout. To ensure a great editing experience deactivate it if you use djangocms-katex by removing TEXT_INLINE_EDITING = True from your settings.py file.

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-katex-0.3.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

djangocms_katex-0.3.0-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file djangocms-katex-0.3.0.tar.gz.

File metadata

  • Download URL: djangocms-katex-0.3.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for djangocms-katex-0.3.0.tar.gz
Algorithm Hash digest
SHA256 39ea293a94f99bd1c111f30d47929b7a5617f530272758f05d7d68194987b55e
MD5 02eda97e79af32ed5335adfdf5ae69a2
BLAKE2b-256 bf0b17248056dbe36896ecdb7bf4379871f26203a4bac9c7654018a38d56f5e5

See more details on using hashes here.

File details

Details for the file djangocms_katex-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for djangocms_katex-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a707438723f438b6f5f19c2514b5c989ff88854c7957f466fdc87ca5e331c0a4
MD5 2cd8daaa4209349a6d8a00218a7afcf3
BLAKE2b-256 e1251c05f80db7b006ce0b269049b3eb839e862b6472c627d6c8deabec795d4e

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