@sveltia/cms 0.123.0 → 0.124.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -43,6 +43,7 @@ This free, open source successor to Netlify/Decap CMS is currently in public bet
43
43
  - [Better asset management](#better-asset-management)
44
44
  - [Better customization](#better-customization)
45
45
  - [Better localization](#better-localization)
46
+ - [Better documentation](#better-documentation)
46
47
  - [Compatibility](#compatibility)
47
48
  - [Current limitations](#current-limitations)
48
49
  - [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
292
293
 
293
294
  ### Better configuration
294
295
 
295
- - 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.
296
296
  - 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.
297
297
  - Also supports [multiple configuration files](#providing-multiple-configuration-files) to allow developers to modularize the configuration.[^197]
298
298
  - 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
624
624
  - KeyValue (Dictionary)
625
625
  - The new `keyvalue` widget allows users to add arbitrary key-value string pairs to a field.[^123]
626
626
  - 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.
627
+ - RichText
628
+ - Currently, the `richtext` widget is a simple alias of `markdown`. We plan to add HTML output support in the future.
627
629
  - UUID
628
630
  - 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]
629
631
  - `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
683
685
  - Enhancements to [event hooks](https://decapcms.org/docs/registering-events/):
684
686
  - Missing `identifier_field` won’t cause an error when the `preSave` hook is triggered.[^306]
685
687
  <!-- - Content can be modified in the `prePublish` hook (once we support editorial workflow).[^307] -->
688
+ - Enhancements to custom field types (widgets):
689
+ - The API method has been renamed from `CMS.registerWidget()` to `CMS.registerFieldType()` for better clarity, while keeping the old name for backward compatibility.[^314]
686
690
  - Async functions can be used for [custom parsers/formatters](https://decapcms.org/docs/custom-formatters/).[^149]
687
691
  - The application renders within the dimensions of a [custom mount element](https://decapcms.org/docs/custom-mounting/), if exists.[^109]
688
692
 
@@ -693,6 +697,10 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
693
697
  - 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]
694
698
  - Long menu item labels, especially in non-English locales, don’t overflow the dropdown container.[^117][^265]
695
699
 
700
+ ### Better documentation
701
+
702
+ - 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.
703
+
696
704
  ## Compatibility
697
705
 
698
706
  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
756
764
  - 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.
757
765
  - 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/).
758
766
  - 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.
759
- - 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.
767
+ - 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.
760
768
 
761
769
  There may be other minor differences in behaviour that are not listed here.
762
770
 
@@ -830,13 +838,14 @@ Currently, Sveltia CMS is primarily intended for existing Netlify/Decap CMS user
830
838
  Or try one of the starter kits for popular frameworks created by community:
831
839
 
832
840
  - Astro
833
- - [astros](https://github.com/zankhq/astros) by [@zanhk](https://github.com/zanhk)
841
+ - [Astros](https://github.com/zankhq/astros) by [@zanhk](https://github.com/zanhk)
834
842
  - [Astro i18n Starter](https://github.com/yacosta738/astro-cms) by [@yacosta738](https://github.com/yacosta738)
835
843
  - Eleventy (11ty)
836
844
  - [Eleventy starter template](https://github.com/danurbanowicz/eleventy-sveltia-cms-starter) by [@danurbanowicz](https://github.com/danurbanowicz)
845
+ - [ZeroPoint](https://getzeropoint.com/) by [@MWDelaney](https://github.com/MWDelaney)
837
846
  - Hugo
838
847
  - [Hugo module](https://github.com/privatemaker/headless-cms) by [@privatemaker](https://github.com/privatemaker)
839
- - [hugolify-admin](https://github.com/Hugolify/hugolify-admin) by [@sebousan](https://github.com/sebousan)
848
+ - [Hugolify](https://www.hugolify.io/) by [@sebousan](https://github.com/sebousan)
840
849
 
841
850
  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.)
842
851
 
@@ -2050,7 +2059,6 @@ Due late 2026
2050
2059
  - User management (Netlify Identity alternative) with roles[^23]
2051
2060
  - Commits without a Git service account (Git Gateway alternative)
2052
2061
  - more enhancements are planned for the future; see the TBD list below
2053
- - End-user documentation
2054
2062
  - Contributor documentation
2055
2063
 
2056
2064
  ### TBD
@@ -2058,7 +2066,7 @@ Due late 2026
2058
2066
  - Tackling the remaining relevant Netlify/Decap CMS issues (some may be included in v2.0 or v3.0):
2059
2067
  - Their [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including:
2060
2068
  - MDX support[^122]
2061
- - [Saving drafts without editorial workflow](https://github.com/sveltia/sveltia-cms/discussions/440)[^261]
2069
+ - [Preview Workflow](https://github.com/sveltia/sveltia-cms/discussions/440)[^261]
2062
2070
  - [Tables in Markdown](https://github.com/sveltia/sveltia-cms/issues/455)[^256]
2063
2071
  - [Config editor](https://github.com/sveltia/sveltia-cms/discussions/452)[^10]
2064
2072
  - [Theming](https://github.com/sveltia/sveltia-cms/issues/29)[^262]
@@ -2068,7 +2076,6 @@ Due late 2026
2068
2076
  - Advanced Relation fields[^242]
2069
2077
  - Cascade updates/deletes[^243]
2070
2078
  - [Quick item additions](https://github.com/sveltia/sveltia-cms/issues/493)[^266]
2071
- - [Reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
2072
2079
  - Autoincrement fields[^286]
2073
2080
  - Unique constraints[^287]
2074
2081
  - Data integrity checks
@@ -2081,13 +2088,25 @@ Due late 2026
2081
2088
  - Proxy for services that don’t support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS):
2082
2089
  - [DeepL Translate](https://github.com/sveltia/sveltia-cms/issues/437)
2083
2090
  - [Git LFS support for GitHub](https://github.com/sveltia/sveltia-cms/discussions/353)[^244]
2091
+ - Content editor enhancements:
2092
+ - Field navigator
2093
+ - Sidebar
2094
+ - View, compare and restore revisions (like [WordPress](https://wordpress.com/support/page-post-revisions/))
2095
+ - [Reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
2096
+ - Validation errors
2097
+ - Input UI improvements
2098
+ - Slider input for number fields
2099
+ - Custom color picker
2100
+ - Custom date/time picker
2101
+ - Image field enhancements:
2102
+ - Camera input, screen capture, QR code generation, AI image generation, etc.
2103
+ - Quick cropping and resizing
2084
2104
  - Search enhancements:
2085
2105
  - Customizable search fields[^274]
2086
2106
  - Advanced search options
2087
2107
  - [Fuzzy search](https://www.fusejs.io/)
2088
2108
  - [Local repository workflow](#working-with-a-local-git-repository) improvements: Git mode[^131] and change detection
2089
2109
  - [Preact+HTM](https://github.com/sveltia/sveltia-cms/discussions/153) or Vue support for custom widgets, editor components and preview templates[^289]
2090
- - View, compare and restore revisions (like [WordPress](https://wordpress.com/support/page-post-revisions/))
2091
2110
  - More integration options: stock photos, stock videos, cloud storage providers, translation services, maps, analytics tools, etc.
2092
2111
  - More AI features for image generation, content writing, etc.
2093
2112
  - 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
2341
2360
 
2342
2361
  [^106]: Netlify/Decap CMS [#2822](https://github.com/decaporg/decap-cms/issues/2822)
2343
2362
 
2344
- [^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)
2363
+ [^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)
2345
2364
 
2346
2365
  [^108]: Netlify/Decap CMS [#6879](https://github.com/decaporg/decap-cms/discussions/6879)
2347
2366
 
@@ -2746,3 +2765,5 @@ This project would not have been possible without the open source Netlify CMS pr
2746
2765
  [^312]: Netlify/Decap CMS [#1004](https://github.com/decaporg/decap-cms/issues/1004)
2747
2766
 
2748
2767
  [^313]: Netlify/Decap CMS [#542](https://github.com/decaporg/decap-cms/issues/542)
2768
+
2769
+ [^314]: Netlify/Decap CMS [#3719](https://github.com/decaporg/decap-cms/issues/3719)