| Name | djangocms-katex JSON |
| Version |
0.5.3
JSON |
| download |
| home_page | None |
| Summary | Provides plugin to render formulae in django CMS |
| upload_time | 2024-04-07 11:14:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
katex
django cms
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# djangocms-katex
[](https://badge.fury.io/py/djangocms-katex)
[](https://pypi.org/project/djangocms-katex/)
[](https://www.djangoproject.com/)
[](https://www.django-cms.org/)
[](https://www.django-cms.org/en/preview-django-cms-40/)
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.
## 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.
## Usage
Once installed, a new puling ("KaTeX formula") is available and can be entered
into any placeholder or within a text plugin.
djangocms-katex only loads required LaTeX JavaScript libraries on demand only.
This might lead to formulae initially only shown in source code. To see the rendered
formula in such a case, please reload the page which ensures that all required
JavaScript is loaded.
Raw data
{
"_id": null,
"home_page": null,
"name": "djangocms-katex",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "KaTeX, django CMS",
"author": null,
"author_email": "Fabian Braun <fsbraun@gmx.de>",
"download_url": "https://files.pythonhosted.org/packages/28/65/0ded990d0cc592935e00b864e6a8b3e913e890d85c071ea6d27deb5d6489/djangocms_katex-0.5.3.tar.gz",
"platform": null,
"description": "# djangocms-katex\n\n[](https://badge.fury.io/py/djangocms-katex)\n[](https://pypi.org/project/djangocms-katex/)\n[](https://www.djangoproject.com/)\n[](https://www.django-cms.org/)\n[](https://www.django-cms.org/en/preview-django-cms-40/)\n\nProvides a django CMS plugin to render formulae using KaTeX and \nits mhchem extension.\n\nThe plugin can display formulae either inline or in display mode. \nIt is text-enabled, and you can add equations to rich text fields \nof djangocms-text-ckeditor.\n\nThe plugin form has a preview functionality that either shows\nthe typed formula. Errors are shown in red.\n\n\n\n## Installation\n\nFor a manual install:\n\n* run `pip install djangocms-katex`\n* add the following entries to your ``INSTALLED_APPS``:\n ```\n \"djangocms_katex\",\n ```\n\n* run `python manage.py migrate`\n\nThe Code plugin uses the ace code editor which is loaded from a CDN by default.\nIf you want the ace code editor to be served from static files, please use\n`djangocms-katex[static-ace]` instead of `djangocms-katex` in your\nrequirements or with pip. Make the static files for the ace code editor available\nto your project by adding `djangocms_static_ace` to your project's\n``INSTALLED_APPS``.\n\ndjangocms-text-ckeditor's inline functionality might interfere with KaTeX's layout.\nTo ensure a great editing experience deactivate it if you use djangocms-katex by\nremoving `TEXT_INLINE_EDITING = True` from your `settings.py` file.\n\n## Usage\n\nOnce installed, a new puling (\"KaTeX formula\") is available and can be entered \ninto any placeholder or within a text plugin.\n\n\ndjangocms-katex only loads required LaTeX JavaScript libraries on demand only. \nThis might lead to formulae initially only shown in source code. To see the rendered\nformula in such a case, please reload the page which ensures that all required\nJavaScript is loaded.\n",
"bugtrack_url": null,
"license": null,
"summary": "Provides plugin to render formulae in django CMS",
"version": "0.5.3",
"project_urls": {
"Homepage": "https://github.com/fsbraun/djangocms-katex"
},
"split_keywords": [
"katex",
" django cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1be63153236b5cb9ca5afa1c1846d3819fec747af9d866029457fcb5f0528517",
"md5": "1bffa85d8f851405c59313ff231ce67b",
"sha256": "39aa60f9514712fdedadabbd88ac077750222da465a02a00e41275383753bd17"
},
"downloads": -1,
"filename": "djangocms_katex-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1bffa85d8f851405c59313ff231ce67b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1356659,
"upload_time": "2024-04-07T11:14:07",
"upload_time_iso_8601": "2024-04-07T11:14:07.561601Z",
"url": "https://files.pythonhosted.org/packages/1b/e6/3153236b5cb9ca5afa1c1846d3819fec747af9d866029457fcb5f0528517/djangocms_katex-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "28650ded990d0cc592935e00b864e6a8b3e913e890d85c071ea6d27deb5d6489",
"md5": "6fe20068b899fa1a638b38b2460d766e",
"sha256": "388acef5f576dc32539b0c7eee02694a166befe2e670e85d73daa7c6d734602a"
},
"downloads": -1,
"filename": "djangocms_katex-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "6fe20068b899fa1a638b38b2460d766e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1315949,
"upload_time": "2024-04-07T11:14:09",
"upload_time_iso_8601": "2024-04-07T11:14:09.989544Z",
"url": "https://files.pythonhosted.org/packages/28/65/0ded990d0cc592935e00b864e6a8b3e913e890d85c071ea6d27deb5d6489/djangocms_katex-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 11:14:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fsbraun",
"github_project": "djangocms-katex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "djangocms-katex"
}
