@sveltia/cms 0.95.0 → 0.95.1

package/README.md

@@ -94,7 +94,8 @@ Welcome to the only Netlify CMS successor you can trust!
 - [Roadmap](#roadmap)
   - [v1.0](#v10)
   - [v2.0](#v20)
-  - [Future](#future)
+  - [v3.0](#v30)
+  - [TBD](#tbd)
 - [Trivia](#trivia)
 - [Related links](#related-links)
   - [As seen on](#as-seen-on)
@@ -135,8 +136,9 @@ Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in
 While we fix reported bugs as quickly as possible, usually within 24 hours, our overall progress may be slower than you think. The thing is, it’s not just a personal project of [@kyoshino](https://github.com/kyoshino), but also a complicated system involving various kinds of activities that require considerable effort:
 
 - Ensuring substantial [compatibility with Netlify/Decap CMS](#current-limitations)
+- Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
 - Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
-  - So far, 240+ issues, or 505+ if including duplicates, have been effectively solved in Sveltia CMS (Yes, you read it right)
+  - So far, 245+ issues, or 510+ if including duplicates, have been effectively solved in Sveltia CMS (Yes, you read it right)
   - Target:
     - 250 issues, or 500 if including duplicates, by GA — Almost there!
     - 400 issues, or 800 if including duplicates, in the future 💪
@@ -150,7 +152,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
 - Responding to requests from the maintainer’s clients
 - Making the code clean and maintainable
 
-![240 Netlify/Decap CMS issues solved in Sveltia CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/headline-1.webp?20250729)<br>
+![245 Netlify/Decap CMS issues solved in Sveltia CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/headline-1.webp?20250808)<br>
 
 ## Differentiators
 
@@ -166,7 +168,7 @@ Note: This lengthy section compares Sveltia CMS with both Netlify CMS and Decap
 - Offers a modern, intuitive user interface that utilizes the full viewport,[^178] inspired in part by the Netlify CMS v3 prototype.[^1][^211][^212][^213][^214]
 - Provides immersive dark mode.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
 - Users can easily manage content on-the-go with mobile and tablet support.[^18][^215]
-  - For a smoother experience, we even go beyond responsive design with optimized navigation, [view transitions](https://developer.chrome.com/docs/web-platform/view-transitions), larger buttons, and other tweaks. However, there are still rough edges, and we are working to fully optimize the app for small screens and touch devices.
+  - For a smoother experience, we even go beyond responsive design with optimized navigation, floating action buttons, smooth [view transitions](https://developer.chrome.com/docs/web-platform/view-transitions), larger buttons, and other tweaks. We’ll continue to fully optimize the app for small screens and touch devices.
   - If you’re already signed in on your desktop, open the Account menu in the top right corner of the CMS, click Sign In with Mobile, and scan the QR code for passwordless sign-in. Your settings will be automatically copied.
 - Sveltia CMS loads all entries at startup. We don’t support backends that cannot retrieve multiple entries at once. This deliberate design choice improves performance and UX by enabling instant full-text searches, fast and powerful relation fields, and linking between assets and entries.
 - Made with [Svelte](https://svelte.dev/), not React, means we can spend more time on UX rather than tedious state management. It also allows us to avoid common fatal React application crashes.[^113][^129] Best of all, Svelte offers great performance.
@@ -642,9 +644,10 @@ Found a compatibility issue or other missing feature? [Let us know](https://gith
 
 Sveltia CMS provides partial compatibility with [Static CMS](https://github.com/StaticJsCMS/static-cms), a now-defunct fork of Netlify CMS. Since Static CMS was archived some time ago, we don’t plan to implement additional compatibility beyond what’s listed below. However, we may still adopt some of their features that we find useful.
 
+Static CMS made [some breaking changes](https://staticjscms.netlify.app/docs/decap-migration-guide) while Sveltia CMS mostly follows Netlify/Decap CMS, so you should review your configuration carefully.
+
 - Configuration options
-  - Static CMS made [some breaking changes](https://staticjscms.netlify.app/docs/decap-migration-guide) to view filters/groups, List widget, etc. while Sveltia CMS follows Netlify/Decap CMS, so you should review your configuration carefully.
-  - The [`sortable_fields`](#specifying-default-sort-field-and-direction), `view_filters` and `view_groups` options with the new `default` option are supported in Sveltia CMS.
+  - Sveltia CMS supports the [`sortable_fields`](#specifying-default-sort-field-and-direction), `view_filters` and `view_groups` options with the new `default` option. We still support the legacy Netlify/Decap CMS format as well, so you can use [either format](https://staticjscms.netlify.app/docs/decap-migration-guide#sortable-fields) for these options.
   - Directory navigation in the Asset Library is partially supported in Sveltia CMS. If you define [collection-specific `media_folder`s](#using-a-custom-media-folder-for-a-collection), these folders will be displayed in the Asset Library and Select File/Image dialog. Display of subfolders within a configured folder will be implemented before GA. We don’t plan to support the `folder_support` and `display_in_navigation` options for `media_library`; subfolders will be displayed with no configuration. ([#301](https://github.com/sveltia/sveltia-cms/issues/301))
   - The `logo_link` global option will not be supported. Use `display_url` or `site_url` instead.
   - The `yaml` global option will not be supported, as Sveltia CMS doesn’t expose the underlying `yaml` library options for forward compatibility reasons. However, we do have some [data output options](#controlling-data-output), including YAML indentation and quotes.
@@ -652,10 +655,11 @@ Sveltia CMS provides partial compatibility with [Static CMS](https://github.com/
   - The `enforce_required_non_default` i18n option will not be supported. Sveitia CMS enforces required fields in all locales by default. However, the `save_all_locales` or `initial_locales` i18n option allows users to [disable non-default locales](#disabling-non-default-locale-content) if needed. Developers can also specify a subset of locales with the `required` field option, e.g. `required: [en]`.
 - Widgets
   - The date/time format options for the DateTime widget are **not compatible** since Static CMS [switched to date-fns](https://staticjscms.netlify.app/docs/decap-migration-guide#dates) while Sveltia CMS continues to use Moment.js (and will soon switch to Day.js). Update your formats accordingly.
-  - The KeyValue widget is implemented in Sveltia CMS with the same options.
-  - The UUID widget is also implemented, but with different options.
+  - The [KeyValue widget](#new-widgets) is implemented in Sveltia CMS with the same options.
+  - The [UUID widget](#new-widgets) is also implemented, but with different options.
   - The `prefix` and `suffix` options for the Boolean, Number and String widgets are implemented as `before_input` and `after_input` in Sveltia CMS, respectively. Our `prefix` and `suffix` options for the String widget are literally a prefix and suffix to the value.
   - The `multiple` option for the File and Image widgets will be implemented in Sveltia CMS before GA. ([#10](https://github.com/sveltia/sveltia-cms/issues/10))
+  - The [breaking change to the List widget](https://staticjscms.netlify.app/docs/decap-migration-guide#list-widget) doesn’t apply to Sveltia CMS. You must use the `field` (singular) option to produce a single subfield with [no `name` output](#understanding-exceptions-in-data-output).
 - Customization
   - `CMS.registerIcon()` will not be supported, as Sveltia CMS includes the Material Symbols font for [custom collection icons](#using-a-custom-icon-for-a-collection) that doesn’t require manual registration.
 
@@ -1366,7 +1370,7 @@ output:
 
 Content is generally saved as key-value pairs in a file, where the key is the field name and the value is the field value. However, there are some exceptions you should be aware of.
 
-If the format is front matter, the `body` field is saved outside of the front matter block, as briefly explained in the [Decap CMS documentation](https://decapcms.org/docs/configuration-options/):
+If the format is front matter, the `body` field is saved outside of the front matter block, as briefly explained in the [Decap CMS documentation](https://decapcms.org/docs/configuration-options/#extension-and-format):
 
 ```yaml
 ---
@@ -1418,10 +1422,10 @@ There are two exceptional cases for the List widget:
    instead of an array of objects:
    ```yaml
    images:
-     - name: https://example.com/image1.jpg
-     - name: https://example.com/image2.jpg
+     - image: https://example.com/image1.jpg
+     - image: https://example.com/image2.jpg
    ```
-   This is not mentioned in the [Decap CMS documentation](https://decapcms.org/docs/widgets/#list), but it’s a known behaviour. If you expect the latter, you can use the `fields` (plural) option to define a single field:
+   This is not mentioned in the [Decap CMS document](https://decapcms.org/docs/widgets/#list), but it’s a known behaviour. If you expect the latter, you can use the `fields` (plural) option to define a single field:
    ```yaml
    - name: images
      label: Images
@@ -1645,32 +1649,36 @@ Due late 2025
 
 Due early 2026
 
-- Implementing [a few deferred Netlify/Decap CMS features](#current-limitations), including editorial workflow and nested collections
+- Implementing [a few deferred Netlify/Decap CMS features](#current-limitations), including editorial workflow and nested collections, while addressing a number of bugs in their implementations
 - Tackling even more Netlify/Decap CMS issues:
   - [Manual entry sorting](https://github.com/sveltia/sveltia-cms/issues/214)[^125]
   - [Directory navigation in the Asset Library](https://github.com/sveltia/sveltia-cms/issues/420)[^240]
-  - [Asset collections](https://github.com/sveltia/sveltia-cms/issues/301)[^271]
-  - [Automatic asset file renaming with templates](https://github.com/sveltia/sveltia-cms/issues/422)[^241]
-  - Advanced Relation fields[^242], including cascade updates/deletes[^243] and quick item additions[^266]
-    - We’ll also implement [reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
-  - (some of them may be included in v1.0)
 - End-user documentation
 
-### Future
-
-- Tackling many of the remaining Netlify/Decap CMS issues:
-  - MDX support[^122]
-  - [Saving drafts without editorial 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]
-  - [Reusable field groups](https://github.com/sveltia/sveltia-cms/discussions/463)[^263]
-  - Offline support[^238]
-  - and other [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc)
-  - (some of them may be included in v2.0)
-- **Sveltia CMS Additions**: edge functions for Cloudflare Workers and possibly other platforms that provide features that cannot be implemented client-side:
+### v3.0
+
+- **Sveltia CMS Additions**: Edge functions for Cloudflare Workers and possibly other platforms that provide features that cannot be implemented client-side:
   - User management (Netlify Identity alternative) with roles[^23]
   - Sign-in without a Git service account (Git Gateway alternative)
+- Contributor documentation
+
+### TBD
+
+- Tackling most of the remaining Netlify/Decap CMS issues (some may be included in v2.0 or v3.0):
+  - [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]
+    - [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]
+    - [Reusable field groups](https://github.com/sveltia/sveltia-cms/discussions/463)[^263]
+    - Offline support[^238]
+  - [Asset collections](https://github.com/sveltia/sveltia-cms/issues/301)[^271]
+  - [Automatic asset file renaming with templates](https://github.com/sveltia/sveltia-cms/issues/422)[^241]
+  - Advanced Relation fields[^242], including cascade updates/deletes[^243] and quick item additions[^266]
+    - We’ll also implement [reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
+  - and many more (100+ issues and discussions)
+- Enhancements to Sveltia CMS Additions (some may be included in v3.0):
   - Post locking (like [WordPress](https://codex.wordpress.org/Post_Locking))[^166]
   - Scheduled posts[^167]
   - Credential management for service API keys, deploy hook URL, etc.
@@ -1682,11 +1690,13 @@ Due early 2026
 - 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.
 - AI integrations for image generation, content writing, translation, etc.
-- Search enhancements
+- Search enhancements:
+  - Customizable search fields[^274]
+  - Advanced search options
+  - [Fuzzy search](https://www.fusejs.io/)
 - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
-- Marketplace for custom widgets, etc.
+- Marketplace for custom widgets, etc.[^273]
 - Official starter templates for the most popular frameworks, including SvelteKit and Next.js
-- Contributor documentation
 - and so much more!
 
 ## Trivia
@@ -2250,3 +2260,7 @@ This software is provided “as is” without any express or implied warranty. W
 [^271]: Netlify/Decap CMS [#1046](https://github.com/decaporg/decap-cms/issues/1046)
 
 [^272]: Netlify/Decap CMS [#4702](https://github.com/decaporg/decap-cms/issues/4702)
+
+[^273]: Netlify/Decap CMS [#919](https://github.com/decaporg/decap-cms/issues/919), [#936](https://github.com/decaporg/decap-cms/issues/936), [#1286](https://github.com/decaporg/decap-cms/issues/1286), [#1288](https://github.com/decaporg/decap-cms/issues/1288), [#1400](https://github.com/decaporg/decap-cms/issues/1400)
+
+[^274]: Netlify/Decap CMS [#549](https://github.com/decaporg/decap-cms/issues/549)