Skip to content
This repository has been archived by the owner on May 12, 2024. It is now read-only.

Commit

Permalink
docs: add deprecation notice (#546)
Browse files Browse the repository at this point in the history
  • Loading branch information
browniebroke authored Nov 28, 2023
1 parent 7b310b2 commit 2f339a4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,13 @@

---

> [!IMPORTANT]
> The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.
**django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a minimal [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms.

This version **does not** include any static files, it's using the TinyMCE from the CDN by default.

**Warning**: TinyMCE 4 is incompatible with TinyMCE 3. Read [TinyMCE](https://www.tinymce.com/) docs for more information about how to configure TimyMCE 4 editor widget.

## Compatibility

- **Python**: 3.8-3.12
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Welcome to django-tinymce4-widget documentation!

```{warning}
The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.
```

**django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms and models.

The main difference with the original fork is that it **does not** include any static files, it's using the TinyMCE from the CDN by default.
Expand Down

0 comments on commit 2f339a4

Please sign in to comment.