@sveltia/cms 0.123.0 → 0.124.0

package/README.md

@@ -43,6 +43,7 @@ This free, open source successor to Netlify/Decap CMS is currently in public bet
   - [Better asset management](#better-asset-management)
   - [Better customization](#better-customization)
   - [Better localization](#better-localization)
+  - [Better documentation](#better-documentation)
 - [Compatibility](#compatibility)
   - [Current limitations](#current-limitations)
   - [Features not to be implemented](#features-not-to-be-implemented)
@@ -292,7 +293,6 @@ We’ve made various improvements to help you get your work done faster and more
 
 ### Better configuration
 
-- We provide comprehensive [compatibility information](#compatibility) to help you avoid unsupported options and configurations that might cause errors. By contrast, the Netlify/Decap CMS documentation does not mention the deprecation of camel case options, the removal of the Date widget and the replacement of Moment.js.
 - Sveltia CMS supports a [JSON configuration file](#providing-a-json-configuration-file) that can be generated for bulk or complex collections.[^60] A [TOML configuration file](#providing-a-toml-configuration-file) is also supported.
 - Also supports [multiple configuration files](#providing-multiple-configuration-files) to allow developers to modularize the configuration.[^197]
 - We provide an [up-to-date JSON schema](#enabling-autocomplete-and-validation-for-the-configuration-file) for YAML/JSON configuration files, which enables autocomplete and validation in VS Code and other editors.[^253] If you use [deprecated options](#deprecations) in a supported code editor, you should receive a warning.
@@ -624,6 +624,8 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
 - KeyValue (Dictionary)
   - The new `keyvalue` widget allows users to add arbitrary key-value string pairs to a field.[^123]
   - While the implementation is compatible with [Static CMS](https://staticjscms.netlify.app/docs/widget-keyvalue), we provide a more intuitive UI. You can press Enter to move focus or add a new row while editing, and the preview is displayed in a clean table.
+- RichText
+  - Currently, the `richtext` widget is a simple alias of `markdown`. We plan to add HTML output support in the future.
 - UUID
   - In addition to [generating UUIDs for entry slugs](#using-a-random-id-for-an-entry-slug), Sveltia CMS supports the proposed `uuid` widget with the following properties:[^12]
     - `prefix`: A string to be prepended to the value. Default: an empty string.
@@ -683,6 +685,8 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
 - Enhancements to [event hooks](https://decapcms.org/docs/registering-events/):
   - Missing `identifier_field` won’t cause an error when the `preSave` hook is triggered.[^306]
   <!-- - Content can be modified in the `prePublish` hook (once we support editorial workflow).[^307] -->
+- Enhancements to custom field types (widgets):
+  - The API method has been renamed from `CMS.registerWidget()` to `CMS.registerFieldType()` for better clarity, while keeping the old name for backward compatibility.[^314]
 - Async functions can be used for [custom parsers/formatters](https://decapcms.org/docs/custom-formatters/).[^149]
 - The application renders within the dimensions of a [custom mount element](https://decapcms.org/docs/custom-mounting/), if exists.[^109]
 
@@ -693,6 +697,10 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
 - The List widget’s `label` and `label_singular` are not converted to lowercase, which is especially problematic in German, where all nouns are capitalized.[^98]
 - Long menu item labels, especially in non-English locales, don’t overflow the dropdown container.[^117][^265]
 
+### Better documentation
+
+- Our [compatibility information](#compatibility) to help you avoid unsupported options and configurations that might cause errors. By contrast, the Netlify/Decap CMS documentation does not mention anything about the deprecation of camel case options, the removal of the Date widget and the replacement of Moment.js. Furthermore, the [Decap blog](https://decapcms.org/blog/decap-3/) claims that Decap CMS 3.0 is ”fully backward compatible” even though it removed the Date widget.
+
 ## Compatibility
 
 We are working to make Sveltia CMS compatible with Netlify/Decap CMS wherever possible so that more users can seamlessly switch to our modern successor. In some casual use cases, Sveltia CMS can be used as a drop-in replacement for Netlify/Decap CMS with [just a one-line code update](#migration).
@@ -756,7 +764,7 @@ There are some differences in behaviour between Sveltia CMS and Netlify/Decap CM
 - In some cases, the [data output](#better-data-output) of Sveltia CMS may differ from that of Netlify/Decap CMS. Notably, Sveltia CMS does not omit empty optional fields by default. If you have data validation in your site generator, this could cause issues. Use the `omit_empty_optional_fields` [output option](#controlling-data-output) if needed.
 - Sveltia CMS requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), meaning it only works with HTTPS, `localhost` or `127.0.0.1` URLs. If you’re running your own remote server and serving content over HTTP, the CMS will not work. We recommend obtaining a TLS certificate from [Let’s Encrypt](https://letsencrypt.org/).
 - As of [Sveltia CMS 0.105.0](https://github.com/sveltia/sveltia-cms/releases/tag/v0.105.0), the `sanitize_preview` option for the [Markdown](https://decapcms.org/docs/widgets/#Markdown) widget is set to `true` by default to prevent potential XSS attacks via entry previews. We recommend keeping this option enabled unless disabling it fixes a broken preview and you fully trust all users of your CMS.
-- As of [Sveltia CMS 0.123.0](https://github.com/sveltia/sveltia-cms/releases/tag/v0.123.0), the `create` option for folder collections defaults to `true` because, in 99.99% of cases, users want to create new entries and adding `create: true` to every folder collection is redundant. To disable entry creation, set `create: false` explicitly.
+- As of [Sveltia CMS 0.123.0](https://github.com/sveltia/sveltia-cms/releases/tag/v0.123.0), the `create` option for folder collections defaults to `true` because, in 99.99% of cases, users want to create new entries and adding `create: true` to every collection is redundant. To disable entry creation, set `create: false` explicitly.
 
 There may be other minor differences in behaviour that are not listed here.
 
@@ -830,13 +838,14 @@ Currently, Sveltia CMS is primarily intended for existing Netlify/Decap CMS user
 Or try one of the starter kits for popular frameworks created by community:
 
 - Astro
-  - [astros](https://github.com/zankhq/astros) by [@zanhk](https://github.com/zanhk)
+  - [Astros](https://github.com/zankhq/astros) by [@zanhk](https://github.com/zanhk)
   - [Astro i18n Starter](https://github.com/yacosta738/astro-cms) by [@yacosta738](https://github.com/yacosta738)
 - Eleventy (11ty)
   - [Eleventy starter template](https://github.com/danurbanowicz/eleventy-sveltia-cms-starter) by [@danurbanowicz](https://github.com/danurbanowicz)
+  - [ZeroPoint](https://getzeropoint.com/) by [@MWDelaney](https://github.com/MWDelaney)
 - Hugo
   - [Hugo module](https://github.com/privatemaker/headless-cms) by [@privatemaker](https://github.com/privatemaker)
-  - [hugolify-admin](https://github.com/Hugolify/hugolify-admin) by [@sebousan](https://github.com/sebousan)
+  - [Hugolify](https://www.hugolify.io/) by [@sebousan](https://github.com/sebousan)
 
 The Netlify/Decap CMS website has more [templates](https://decapcms.org/docs/start-with-a-template/) and [examples](https://decapcms.org/docs/examples/). You can probably use one of them and switch to Sveltia CMS. (Note: These third-party resources are not necessarily reviewed by the Sveltia CMS team.)
 
@@ -2050,7 +2059,6 @@ Due late 2026
   - User management (Netlify Identity alternative) with roles[^23]
   - Commits without a Git service account (Git Gateway alternative)
   - more enhancements are planned for the future; see the TBD list below
-- End-user documentation
 - Contributor documentation
 
 ### TBD
@@ -2058,7 +2066,7 @@ Due late 2026
 - Tackling the remaining relevant Netlify/Decap CMS issues (some may be included in v2.0 or v3.0):
   - Their [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including:
     - MDX support[^122]
-    - [Saving drafts without editorial workflow](https://github.com/sveltia/sveltia-cms/discussions/440)[^261]
+    - [Preview Workflow](https://github.com/sveltia/sveltia-cms/discussions/440)[^261]
     - [Tables in Markdown](https://github.com/sveltia/sveltia-cms/issues/455)[^256]
     - [Config editor](https://github.com/sveltia/sveltia-cms/discussions/452)[^10]
     - [Theming](https://github.com/sveltia/sveltia-cms/issues/29)[^262]
@@ -2068,7 +2076,6 @@ Due late 2026
     - Advanced Relation fields[^242]
       - Cascade updates/deletes[^243]
       - [Quick item additions](https://github.com/sveltia/sveltia-cms/issues/493)[^266]
-      - [Reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
     - Autoincrement fields[^286]
     - Unique constraints[^287]
     - Data integrity checks
@@ -2081,13 +2088,25 @@ Due late 2026
   - Proxy for services that don’t support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS):
     - [DeepL Translate](https://github.com/sveltia/sveltia-cms/issues/437)
     - [Git LFS support for GitHub](https://github.com/sveltia/sveltia-cms/discussions/353)[^244]
+- Content editor enhancements:
+  - Field navigator
+  - Sidebar
+    - View, compare and restore revisions (like [WordPress](https://wordpress.com/support/page-post-revisions/))
+    - [Reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
+    - Validation errors
+- Input UI improvements
+  - Slider input for number fields
+  - Custom color picker
+  - Custom date/time picker
+  - Image field enhancements:
+    - Camera input, screen capture, QR code generation, AI image generation, etc.
+    - Quick cropping and resizing
 - Search enhancements:
   - Customizable search fields[^274]
   - Advanced search options
   - [Fuzzy search](https://www.fusejs.io/)
 - [Local repository workflow](#working-with-a-local-git-repository) improvements: Git mode[^131] and change detection
 - [Preact+HTM](https://github.com/sveltia/sveltia-cms/discussions/153) or Vue support for custom widgets, editor components and preview templates[^289]
-- View, compare and restore revisions (like [WordPress](https://wordpress.com/support/page-post-revisions/))
 - More integration options: stock photos, stock videos, cloud storage providers, translation services, maps, analytics tools, etc.
 - More AI features for image generation, content writing, etc.
 - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
@@ -2341,7 +2360,7 @@ This project would not have been possible without the open source Netlify CMS pr
 
 [^106]: Netlify/Decap CMS [#2822](https://github.com/decaporg/decap-cms/issues/2822)
 
-[^107]: Netlify/Decap CMS [#332](https://github.com/decaporg/decap-cms/issues/332), [#683](https://github.com/decaporg/decap-cms/issues/683), [#999](https://github.com/decaporg/decap-cms/issues/999), [#1456](https://github.com/decaporg/decap-cms/issues/1456), [#4175](https://github.com/decaporg/decap-cms/issues/4175), [#4818](https://github.com/decaporg/decap-cms/issues/4818), [#5688](https://github.com/decaporg/decap-cms/issues/5688), [#6828](https://github.com/decaporg/decap-cms/issues/6828), [#6829](https://github.com/decaporg/decap-cms/issues/6829), [#6862](https://github.com/decaporg/decap-cms/issues/6862), [#7023](https://github.com/decaporg/decap-cms/issues/7023)
+[^107]: Netlify/Decap CMS [#332](https://github.com/decaporg/decap-cms/issues/332), [#683](https://github.com/decaporg/decap-cms/issues/683), [#999](https://github.com/decaporg/decap-cms/issues/999), [#1456](https://github.com/decaporg/decap-cms/issues/1456), [#4175](https://github.com/decaporg/decap-cms/issues/4175), [#4818](https://github.com/decaporg/decap-cms/issues/4818), [#5688](https://github.com/decaporg/decap-cms/issues/5688), [#6828](https://github.com/decaporg/decap-cms/issues/6828), [#6829](https://github.com/decaporg/decap-cms/issues/6829), [#6862](https://github.com/decaporg/decap-cms/issues/6862), [#7023](https://github.com/decaporg/decap-cms/issues/7023), [#7680](https://github.com/decaporg/decap-cms/issues/7680)
 
 [^108]: Netlify/Decap CMS [#6879](https://github.com/decaporg/decap-cms/discussions/6879)
 
@@ -2746,3 +2765,5 @@ This project would not have been possible without the open source Netlify CMS pr
 [^312]: Netlify/Decap CMS [#1004](https://github.com/decaporg/decap-cms/issues/1004)
 
 [^313]: Netlify/Decap CMS [#542](https://github.com/decaporg/decap-cms/issues/542)
+
+[^314]: Netlify/Decap CMS [#3719](https://github.com/decaporg/decap-cms/issues/3719)