@sveltia/cms 0.78.2 → 0.79.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
@@ -97,9 +97,9 @@ The free, open source alternative/successor to Netlify/Decap CMS is now in publi
97
97
 
98
98
  Sveltia CMS was born in November 2022, when the progress of Netlify CMS was stalled for more than six months. [@kyoshino](https://github.com/kyoshino)’s clients wanted to replace their Netlify CMS instances without much effort, mainly to get better internationalization (i18n) support.
99
99
 
100
- To achieve radical improvements in UX, performance, i18n and other areas, it was ultimately decided to build an alternative from the ground up, while ensuring an easy migration path from the other. After proving the concept with a rapid [Svelte](https://svelte.dev/) prototype, development was accelerated to address their primary use cases. The new product has since been named Sveltia CMS and released as open source software to encourage wider adoption.
100
+ To achieve radical improvements in UX, performance, i18n and other areas, it was ultimately decided to build an alternative from the ground up, while ensuring an easy migration path from the other. After proving the idea with a rapid [Svelte](https://svelte.dev/) prototype, development was accelerated to address their primary use cases. The new product has since been named Sveltia CMS and released as open source software to encourage wider adoption.
101
101
 
102
- We loved the concept of Netlify CMS turning a Git repository into a database with a single page app served from a CDN plus a plain YAML config file and we wanted to revive it, modernize it, and take it to the next level.
102
+ We loved the well-received concept of Netlify CMS: turning a Git repository into a database with a single page app served from a CDN plus a plain YAML config file. We wanted to revive it, modernize it, and take it to the next level.
103
103
 
104
104
  ### Our advantage
105
105
 
@@ -109,9 +109,9 @@ Due to its unfortunate abandonment in early 2022, Netlify CMS spawned 3 successo
109
109
  - **Sveltia CMS**: not a fork but a **complete rewrite** or “total reboot”, started in November 2022, first appeared on GitHub in March 2023
110
110
  - [Decap CMS](https://github.com/decaporg/decap-cms): a rebranded version, [announced in February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/) as the official successor with a Netlify agency partner taking ownership — mostly stagnant, with only occasional releases
111
111
 
112
- Sveltia CMS is the only project that doesn’t inherit the complexity, technical debt and numerous bugs of Netlify CMS, which was launched back in 2015. We are confident that our decision to rebuild the application from scratch was the right and inevitable one, as proven by the [hundreds of improvements](#differentiators) we have already made.
112
+ Sveltia CMS is the only project that doesn’t inherit the complexity, technical debt, and numerous bugs of Netlify CMS, which was launched in 2015. Our product is better by design: We rebuilt the app from the ground up using a [modern framework](https://svelte.dev/), with full access to the [predecessor’s issue tracker](https://github.com/decaporg/decap-cms/issues). This lets us make [hundreds of improvements](#differentiators) without getting stuck in the old code.
113
113
 
114
- While Sveltia CMS is specifically designed to replace legacy Netlify CMS instances, it also aims to serve as a substitute for the other Netlify CMS successors. We hope that, especially with the [robust i18n support](#better-i18n-support), our product will eventually become an attractive choice for anyone looking for a free headless CMS.
114
+ While Sveltia CMS was created to replace legacy Netlify CMS instances, it can also be used as an alternative to other Netlify CMS successors. With its [solid i18n support](#better-i18n-support), we’re hoping our product will eventually be an appearing option for anyone looking for a free headless CMS.
115
115
 
116
116
  ### Our goals
117
117
 
@@ -130,20 +130,21 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
130
130
  - Ensuring substantial [compatibility with Netlify/Decap CMS](#compatibility)
131
131
  - Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
132
132
  - Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
133
- - So far, 210+ issues, or 425+ if including duplicates, have been effectively solved in Sveltia CMS
133
+ - So far, 215+ issues, or 425+ if including duplicates, have been effectively solved in Sveltia CMS
134
134
  - Target:
135
135
  - 200 issues, or 400 if including duplicates, by GA — We did it! 🎉
136
- - 350 issues, or 700 if including duplicates, in the future
137
- - or everything that’s relevant, fixable and worthwhile 💪
136
+ - 350 issues, or 700 if including duplicates, in the future 💪
137
+ - or every single issue that’s relevant, fixable, and worth dealing with 🔥
138
138
  - Issues include everything from feature requests to bug reports and [issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) or without an effective solution, as well as [discussions](https://github.com/decaporg/decap-cms/discussions) and stalled [pull requests](https://github.com/decaporg/decap-cms/pulls)
139
- - Most of the bugs, including annoying crashes, are already solved
139
+ - Many of the bugs, including the annoying crashes, have already been solved
140
+ - The remaining bugs are mostly related to [unimplemented features](#current-limitations)
140
141
  - Many of their [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) are on our table or already implemented in Sveltia CMS
141
142
  - Solving [our own issues](https://github.com/sveltia/sveltia-cms/issues)
142
143
  - Implementing our own enhancement ideas for every part of the product
143
144
  - Responding to requests from the maintainer’s clients
144
145
  - Making the code clean and maintainable
145
146
 
146
- ![210 Netlify/Decap CMS issues solved in Sveltia CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/headline-1.webp?20250519)<br>
147
+ ![215 Netlify/Decap CMS issues solved in Sveltia CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/headline-1.webp?20250530)<br>
147
148
 
148
149
  ## Differentiators
149
150
 
@@ -157,7 +158,7 @@ Netlify/Decap CMS users will definitely be pleased and surprised by the numerous
157
158
  - 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]
158
159
  - Provides immersive dark mode.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
159
160
  - Users can easily manage content on-the-go with mobile and tablet support.[^18][^215]
160
- - For a smoother experience, we even go beyond responsive design with [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.
161
+ - 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.
161
162
  - 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.
162
163
  - 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.
163
164
  - Other crashes in Netlify/Decap CMS are also irrelevant to us, making Sveltia CMS much more stable.[^112][^203][^204]
@@ -241,6 +242,7 @@ Netlify/Decap CMS users will definitely be pleased and surprised by the numerous
241
242
  - We provide [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth) for GitHub and GitLab.
242
243
  - Users won’t get a 404 Not Found error when you sign in to the GitLab backend.[^115]
243
244
  - Our Gitea backend is high-performing because it retrieves multiple entries simultaneously. It also won’t cause 400 Bad Request errors due to the presence of `DRAFT_MEDIA_FILES` in file paths.[^222]
245
+ - The OAuth access token is automatically renewed when using the GitLab or Gitea backend with PKCE authorization.[^224] Token renewal for other backend configurations will be implemented later.
244
246
  - Features the all-new local backend that boosts DX. See the [productivity section](#better-productivity) above.
245
247
  - Developers can select the local and remote backends while working on a local server.
246
248
  - The Test backend saves entries and assets in the browser’s [origin private file system](https://web.dev/articles/origin-private-file-system) (OPFS) so that changes are not discarded when the browser tab is closed or reloaded.[^194] The persistent storage support works with all modern browsers [except Safari](https://bugs.webkit.org/show_bug.cgi?id=254726).
@@ -344,6 +346,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
344
346
  - Required fields, not optional fields, are marked for efficient data entry.
345
347
  - Users can revert changes to all fields or a specific field.
346
348
  - If you revert changes and there are no unsaved changes, the Save button is disabled as expected.[^118]
349
+ - The new `readonly` field option makes the field read-only. This is useful when a `default` value is provided and the field should not be editable by users.[^223]
347
350
  - Fields with validation errors are automatically expanded if they are part of nested, collapsed objects.[^40]
348
351
  - A full regular expression, including flags, can be used for the widget `pattern` option.[^82] For example, if you want to allow 280 characters or less in a multiline text field, you could write `/^.{0,280}$/s` (but you can now use the `maxlength` option instead.)
349
352
  - A long validation error message is displayed in full, without being hidden behind the field label.[^59]
@@ -357,7 +360,8 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
357
360
  - For better performance, the Preview Pane doesn’t use an `<iframe>`.[^179]
358
361
  - The Preview Pane displays all fields, including each label, making it easier to see which fields are populated.
359
362
  - Clicking a field in the Preview Pane focuses the corresponding field in the Edit Pane.[^41] It automatically expands when collapsed.
360
- - This is equivalent to the (misleading) visual editing feature introduced in [Decap 3.6.0](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.6.0), but our click-to-highlight feature is enabled by default; you don’t need to opt in with the `editor.visualEditing` collection option. Also, image previews are not broken in Sveltia CMS.[^188]
363
+ - This is equivalent to the (misleading) visual editing feature introduced in [Decap 3.6.0](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.6.0), but our click-to-highlight feature is enabled by default; you don’t need to opt in with the `editor.visualEditing` collection option.
364
+ - Our implementation doesn’t cause a module import error or broken image previews.[^225][^188]
361
365
  - The Preview Pane doesn’t cause a scrolling issue.[^136]
362
366
  - The Preview Pane doesn’t crash with a Minified React error.[^186]
363
367
  - Provides better scroll synchronization between the panes when editing or previewing an entry.[^92]
@@ -557,7 +561,7 @@ However, 100% feature parity is not planned, and some features are still missing
557
561
  - [Number](https://decapcms.org/docs/widgets/#number) widget: `valueType`
558
562
  - [Relation](https://decapcms.org/docs/widgets/#relation) widget: `displayFields`, `searchFields`, `valueField`
559
563
  - Note: Some other camel case options, including Color widget options, are not deprecated.
560
- - The deprecated Date widget: It has already been removed from Decap CMS 3.0. Use the DateTime widget with the [`time_format: false` option](#changing-the-input-type-of-a-datetime-field) instead.
564
+ - The deprecated Date widget: It was removed from Decap CMS 3.0 and Sveltia CMS 0.10. Use the DateTime widget with the [`time_format: false` option](#changing-the-input-type-of-a-datetime-field) instead.
561
565
  - Some date/time format tokens: [Decap CMS 3.1.1](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.1.1) replaced Moment.js with Day.js, and Sveltia CMS will follow suit soon. Since [Day.js tokens](https://day.js.org/docs/en/display/format) are not 100% compatible with [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/), this could be a breaking change in certain cases.
562
566
  - The theme and keymap inline settings of the Code widget, along with support for some languages: We use the [Prism](https://prismjs.com/)-powered code block functionality in Lexical instead of [CodeMirror](https://codemirror.net/). Prism may be [replaced by Shiki](https://github.com/facebook/lexical/issues/6575) in the future.
563
567
  - Remark plugins for the Markdown widget: Not compatible with our Lexical-based rich text editor.
@@ -1830,3 +1834,9 @@ This software is provided “as is” without any express or implied warranty. W
1830
1834
  [^221]: Netlify/Decap CMS [#3421](https://github.com/decaporg/decap-cms/issues/3421)
1831
1835
 
1832
1836
  [^222]: Netlify/Decap CMS [#7281](https://github.com/decaporg/decap-cms/issues/7281) — The issue was closed, but the attached PR is not yet merged.
1837
+
1838
+ [^223]: Netlify/Decap CMS [#7483](https://github.com/decaporg/decap-cms/issues/7483)
1839
+
1840
+ [^224]: Netlify/Decap CMS [#7352](https://github.com/decaporg/decap-cms/issues/7352)
1841
+
1842
+ [^225]: Netlify/Decap CMS [#7401](https://github.com/decaporg/decap-cms/issues/7401)