version 5.1.0

Author: engram-design

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.1.0 - 2025-03-21
+
+### Added
+- Add support for [CKEditor](https://plugins.craftcms.com/ckeditor).
+
+### Deprecated
+- Deprecate [Redactor](https://plugins.craftcms.com/redactor) support.
+
 ## 5.0.0 - 2024-05-13
 
 ### Changed

README.md

@@ -1,7 +1,7 @@
 <p align="center"><img src="https://verbb.imgix.net/plugins/footnotes/footnotes-icon.svg" width="100" height="100" alt="Footnotes icon"></p>
 <h1 align="center">Footnotes for Craft CMS</h1>
 
-Footnotes is a Craft CMS plugin to add a footnote button to Redactor fields.
+Footnotes is a Craft CMS plugin to add a footnote button to [CKEditor](https://plugins.craftcms.com/ckeditor) fields.
 
 ## Documentation
 Visit the [Footnotes Plugin page](https://verbb.io/craft-plugins/footnotes) for all documentation, guides, pricing and developer resources.

composer.json

@@ -1,14 +1,15 @@
 {
     "name": "verbb/footnotes",
-    "description": "Adds a footnotes feature to Redactor fields and Twig templates.",
+    "description": "Adds a footnotes feature to CKEditor fields and Twig templates.",
     "type": "craft-plugin",
-    "version": "5.0.0",
+    "version": "5.1.0",
     "keywords": [
         "craft",
         "cms",
         "craftcms",
         "craft-plugin",
         "redactor",
+        "ckeditor",
         "footnotes"
     ],
     "support": {

docs/feature-tour/usage.md

@@ -1,20 +1,13 @@
 # Usage
-Firstly, you'll need to add the Footnotes plugin to your Redactor config. These are located at `config/redactor/*.json`. Add a `footnotebutton` value to the `plugins` array in the config.
+Once Footnotes has been installed, in the Craft CMS control panel, navigate to any CKEditor field in your Craft settings (Settings > Fields).
 
-```json
-{
-    "buttons": ["format", "bold", "italic"],
-    "plugins": ["source", "fullscreen", "footnotebutton"]
-}
-```
-
-With this in place, a new button for adding footnotes should appear in Redactor fields (for the Redactor fields that use this config).
+For the **CKEditor Config** setting, either create a new config, or edit an existing one. You'll see a button with the Footnotes icon (an asterisk) as an available button to add to your toolbar. Drag and drop it to the appropriate position in your toolbar.
 
 ## Render your content
-When rendering the Redactor field containing footnotes, you'll need to use the `footnotes` Twig filter.
+When rendering the CKEditor field containing footnotes, you'll need to use the `footnotes` Twig filter.
 
 ```twig
-{{ entry.myRedactorHandle | footnotes }}
+{{ entry.myContentField | footnotes }}
 ```
 
 ## Render footnotes
@@ -61,5 +54,5 @@ From here, you might want to add a link that jumps readers back to their positio
 You can also include a range of options to assist with rendering:
 
 ```twig
-{{ entry.myRedactorHandle | footnotes({ anchorAttributes: { class: 'some-class' }, superscriptAttributes: { class: 'another-class' } }) }}
+{{ entry.myContentField | footnotes({ anchorAttributes: { class: 'some-class' }, superscriptAttributes: { class: 'another-class' } }) }}
 ```