Skip to content

Commit

Permalink
Explain the reasoning
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiask committed Dec 17, 2024
1 parent 53f5616 commit 7c61ab9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ Next version

- Changed the editor foundation to use `Tiptap <https://tiptap.dev/>__`. Tiptap
uses ProseMirror under the hood, but offers an extension framework which I'd
have to reinvent and there's really no point to do that.
have to reinvent and there's really no point to do that. The change should be
backwards compatible if you only used the Python-level integration. The
JavaScript integration has changed a lot, ``DjangoProseEditor.createEditor``
doesn't exist anymore.


0.9 (2024-10-30)
Expand Down
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,15 @@ The announcements file is expected to initialize the editor by using the
``DjangoProseEditor`` library which is available on the browser ``window``
global. The example looks a bit involved, and it is -- but, this unlocks the
capability to add project-specific extensions without having to rebuild the
editor foundations:
editor foundations.

**Note:** If browser support for ES modules and multiple importmaps were better
I would export a proper ES module instead of using this global variable, and
I'd probably also split up the library a bit so that people who only want a
restricted editor do not have to load and run the additional ~100KiB of
JavaScript code for the more exotic extensions.

Here's the example:

.. code-block:: javascript
Expand Down

0 comments on commit 7c61ab9

Please sign in to comment.