Skip to content

Commit 40c9637

Browse files
hvladshvlads
committed
chore: add CHANGELOG, issue templates and README badges
1 parent 5ed45a8 commit 40c9637

File tree

4 files changed

+205
-1
lines changed

4 files changed

+205
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
## Describe the bug
8+
A clear and concise description of what the bug is.
9+
10+
## Steps to reproduce
11+
1. ...
12+
2. ...
13+
3. ...
14+
15+
## Expected behavior
16+
What you expected to happen.
17+
18+
## Actual behavior
19+
What actually happened. Include error messages and stack traces if applicable.
20+
21+
## Environment
22+
- Python version:
23+
- Django version:
24+
- django-ckeditor-5 version:
25+
- Browser (if relevant):
26+
27+
## Additional context
28+
Any other context, config snippets, or screenshots.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
## Problem
8+
A clear and concise description of the problem or limitation. E.g. "I need to..."
9+
10+
## Proposed solution
11+
How you'd like it to work.
12+
13+
## Alternatives considered
14+
Any alternative solutions or workarounds you've considered.
15+
16+
## Additional context
17+
Any other context, mockups, or examples.

‎CHANGELOG.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Changelog
2+
3+
## [0.2.20] - 2026-02-21
4+
5+
### Added
6+
- JS callback support in config via `callback:functionName` prefix — enables plugins like Mention to use JS functions in `CKEDITOR_5_CONFIGS` ([#320](https://github.com/hvlads/django-ckeditor-5/pull/320), closes [#298](https://github.com/hvlads/django-ckeditor-5/issues/298))
7+
- Read-only mode for disabled textareas — CKEditor now respects the `disabled` attribute ([#322](https://github.com/hvlads/django-ckeditor-5/pull/322), closes [#192](https://github.com/hvlads/django-ckeditor-5/issues/192))
8+
- `CKEDITOR_5_IMAGE_CLEANUP` setting — automatic image cleanup on update/delete is now opt-in, default `False` ([#321](https://github.com/hvlads/django-ckeditor-5/pull/321))
9+
10+
### Fixed
11+
- Eliminated unnecessary SQL query on object create in `pre_save` signal; consolidated multiple SELECTs into one for models with several `CKEditor5Field`s ([#321](https://github.com/hvlads/django-ckeditor-5/pull/321), closes [#289](https://github.com/hvlads/django-ckeditor-5/issues/289))
12+
- CSRF_COOKIE_HTTPONLY=True breaks file upload ([#319](https://github.com/hvlads/django-ckeditor-5/pull/319), closes [#310](https://github.com/hvlads/django-ckeditor-5/issues/310))
13+
- Clean empty HTML content for optional CKEditor5 fields ([#309](https://github.com/hvlads/django-ckeditor-5/pull/309), closes [#271](https://github.com/hvlads/django-ckeditor-5/issues/271))
14+
- Handle STORAGES default OPTIONS for Django 4.2 compatibility ([#317](https://github.com/hvlads/django-ckeditor-5/pull/317))
15+
16+
### Upgraded
17+
- CKEditor 5 from 47.3.0 to 47.5.0 ([#318](https://github.com/hvlads/django-ckeditor-5/pull/318))
18+
19+
20+
## [0.2.19] - 2025-01-10
21+
22+
### Upgraded
23+
- CKEditor 5 from 44.1.0 to 47.3.0
24+
25+
### CI
26+
- Added tox for multi-version Django/Python testing
27+
- Added Release Drafter for automated changelog generation
28+
29+
30+
## [0.2.18] - 2024-11-01
31+
32+
### Fixed
33+
- Fixed signals storage class instantiation
34+
- Refined regex to better handle `<img>` tags with varied attribute orders
35+
36+
### Upgraded
37+
- CKEditor 5 dependencies to version 45.x
38+
39+
40+
## [0.2.16] - 2024-10-01
41+
42+
### Added
43+
- Automatic cleanup of unused CKEditor images on update and delete ([#275](https://github.com/hvlads/django-ckeditor-5/pull/275))
44+
45+
### Upgraded
46+
- CKEditor 5 from 43.2.0 to 44.1.0
47+
48+
49+
## [0.2.14] - 2024-08-01
50+
51+
### Added
52+
- FullScreen plugin
53+
- File size limit for image and file uploads (`CKEDITOR_5_MAX_FILE_SIZE`)
54+
- Permissions check for file upload (`CKEDITOR_5_FILE_UPLOAD_PERMISSION`)
55+
56+
### Fixed
57+
- Sync CKEditor content with textarea for form validation ([#251](https://github.com/hvlads/django-ckeditor-5/pull/251))
58+
- Use arrow notation to call `createEditors()` on `formset:added` event
59+
60+
### Upgraded
61+
- CKEditor 5 from 41.3.1 to 43.2.0
62+
63+
64+
## [0.2.13] - 2024-05-01
65+
66+
### Added
67+
- Custom upload URL support (`CK_EDITOR_5_UPLOAD_FILE_VIEW_NAME`) ([#218](https://github.com/hvlads/django-ckeditor-5/pull/218))
68+
- Editor instance callback via `window.ckeditorRegisterCallback` / `window.ckeditorUnregisterCallback`
69+
- Plugins: ShowBlocks, SelectAll, FindAndReplace
70+
- Full page HTML support
71+
- Special characters support ([#193](https://github.com/hvlads/django-ckeditor-5/issues/193))
72+
- File upload as links support
73+
- Return 400 response code with error message on upload failure
74+
75+
### Upgraded
76+
- CKEditor 5 from 41.1.0 to 41.3.1
77+
78+
79+
## [0.2.12] - 2024-03-01
80+
81+
### Added
82+
- Django user language support (`CKEDITOR_5_USER_LANGUAGE`)
83+
- Support for dynamically loaded editors (MutationObserver)
84+
- Regex string to RegExp conversion in JSON config reviver
85+
86+
### Fixed
87+
- Rendering complete form
88+
- CKEditor5-html-embed plugin
89+
- Restore compatibility with django-nested-admin
90+
91+
### Upgraded
92+
- CKEditor 5 from 40.2.0 to 41.1.0
93+
94+
95+
## [0.2.11] - 2023-12-01
96+
97+
### Added
98+
- Type annotations
99+
- Improved error handling
100+
101+
### Upgraded
102+
- CKEditor 5 to 40.2.0
103+
104+
105+
## [0.2.10] - 2023-10-01
106+
107+
### Fixed
108+
- CKEditor layout with flexbox in Django 4.2.x ([#162](https://github.com/hvlads/django-ckeditor-5/issues/162))
109+
- `json_script` filter argument ([#164](https://github.com/hvlads/django-ckeditor-5/issues/164))
110+
111+
### Upgraded
112+
- CKEditor 5 dependencies to version 39.0.2
113+
114+
115+
## [0.2.9] - 2023-08-01
116+
117+
### Added
118+
- HorizontalLine and LinkImage plugins
119+
- Support for django-nested-admin
120+
121+
### Fixed
122+
- Label element floating issue for CKEditor5Field ([#152](https://github.com/hvlads/django-ckeditor-5/issues/152))
123+
- Issue with initialising empty forms
124+
125+
### Upgraded
126+
- CKEditor 5 to 38.1.1
127+
128+
129+
## [0.2.8] - 2023-06-01
130+
131+
### Added
132+
- Style plugin ([#139](https://github.com/hvlads/django-ckeditor-5/issues/139))
133+
- pytest for example project
134+
135+
### Fixed
136+
- WordCount plugin removal TypeError in app.js ([#140](https://github.com/hvlads/django-ckeditor-5/issues/140))
137+
- Refactored DEFAULT_FILE_STORAGE to STORAGES["default"] ([#138](https://github.com/hvlads/django-ckeditor-5/issues/138))
138+
139+
140+
## [0.2.7] - 2023-05-01
141+
142+
### Added
143+
- Markdown plugin ([#131](https://github.com/hvlads/django-ckeditor-5/issues/131))

‎README.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1-
/Django CKEditor 5
1+
Django CKEditor 5
22
==================
33

4+
.. image:: https://img.shields.io/pypi/v/django-ckeditor-5.svg
5+
:target: https://pypi.org/project/django-ckeditor-5/
6+
:alt: PyPI version
7+
8+
.. image:: https://img.shields.io/pypi/dm/django-ckeditor-5.svg
9+
:target: https://pypi.org/project/django-ckeditor-5/
10+
:alt: PyPI downloads
11+
12+
.. image:: https://img.shields.io/pypi/pyversions/django-ckeditor-5.svg
13+
:target: https://pypi.org/project/django-ckeditor-5/
14+
:alt: Python versions
15+
16+
.. image:: https://img.shields.io/github/license/hvlads/django-ckeditor-5.svg
17+
:target: https://github.com/hvlads/django-ckeditor-5/blob/master/LICENSE
18+
:alt: License
19+
420
CKEditor 5 for Django >= 2.0
521

622
Quick start

0 commit comments

Comments
 (0)