https://github.com/jazzband/django-tinymce

TinyMCE integration for Django
https://github.com/jazzband/django-tinymce

Last synced: 9 days ago
JSON representation

TinyMCE integration for Django

• Host: GitHub
• URL: https://github.com/jazzband/django-tinymce
• Owner: jazzband
• License: mit
• Created: 2010-09-13T14:10:29.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T07:22:34.000Z (6 months ago)
• Last Synced: 2024-05-22T15:11:39.313Z (6 months ago)
• Language: JavaScript
• Homepage: http://django-tinymce.readthedocs.org/
• Size: 10.3 MB
• Stars: 1,245
• Watchers: 26
• Forks: 316
• Open Issues: 36
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-django-admin - django-tinymce - TinyMCE text editor integration for Django (Packages to install at your project / Widgets / Fields)
• -awesome-django - django-tinymce - TinyMCE integration for Django. (Third-Party Packages / Editors)
• awesome-django - django-tinymce - TinyMCE integration for Django. (Third-Party Packages / Editors)

README

        
django-tinymce

==============

**django-tinymce** is a Django application that contains a widget to render a form field as a TinyMCE editor.

It supports Python 3.8+ and Django 3.2 to 5.0. Using TinyMCE 6.8.4.

.. image:: https://jazzband.co/static/img/badge.svg

        :target: https://jazzband.co/

        :alt: Jazzband

.. image:: https://img.shields.io/pypi/v/django-tinymce.svg

        :target: https://pypi.python.org/pypi/django-tinymce

.. image:: https://img.shields.io/pypi/pyversions/django-tinymce.svg

        :target: https://pypi.python.org/pypi/django-tinymce

.. image:: https://img.shields.io/pypi/djversions/django-tinymce.svg

        :target: https://pypi.org/project/django-tinymce/

.. image:: https://img.shields.io/pypi/dm/django-tinymce.svg

        :target: https://pypi.python.org/pypi/django-tinymce

.. image:: https://github.com/jazzband/django-tinymce/workflows/Test/badge.svg

   :target: https://github.com/jazzband/django-tinymce/actions

   :alt: GitHub Actions

.. image:: https://codecov.io/gh/jazzband/django-tinymce/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/jazzband/django-tinymce

   :alt: Code coverage

Quickstart

==========

Install django-tinymce:

.. code-block:: bash

    $ pip install django-tinymce

Add tinymce to INSTALLED_APPS in settings.py for your project:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'tinymce',

    )

Add tinymce.urls to urls.py for your project:

.. code-block:: python

    urlpatterns = [

        ...

        path('tinymce/', include('tinymce.urls')),

    ]

In your code:

.. code-block:: python

    from django.db import models

    from tinymce.models import HTMLField

    class MyModel(models.Model):

        ...

        content = HTMLField()

**django-tinymce** uses staticfiles so everything should work as expected, different use cases (like using widget instead of HTMLField) and other stuff is available in documentation.

Documentation

=============

https://django-tinymce.readthedocs.org/

Support and updates

===================

Use github issues https://github.com/jazzband/django-tinymce/issues

License

=======

Originally written by Joost Cassee.

This program is licensed under the MIT License (see LICENSE.txt)