@sveltia/cms 0.61.1 → 0.61.2
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 +19 -15
- package/dist/sveltia-cms.js +162 -162
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +160 -160
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -110,7 +110,7 @@ While Sveltia CMS is specifically designed to replace legacy Netlify CMS instanc
|
|
|
110
110
|
|
|
111
111
|
## Development status
|
|
112
112
|
|
|
113
|
-
Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in
|
|
113
|
+
Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in mid-2025. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) for updates. See also our [roadmap](#roadmap).
|
|
114
114
|
|
|
115
115
|
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 involves different kinds of activities that require considerable effort:
|
|
116
116
|
|
|
@@ -494,32 +494,32 @@ However, 100% feature parity is not planned, and some features are still missing
|
|
|
494
494
|
|
|
495
495
|
### Features not to be implemented
|
|
496
496
|
|
|
497
|
-
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends**: For performance reasons. [Git Gateway](https://github.com/netlify/git-gateway) has not been actively maintained since Netlify CMS was abandoned, and it’s known to be slow and prone to rate limit violations. We plan to develop a GraphQL-based high-performance alternative in the future. We may also support the other platforms if their APIs improve to allow the CMS to fetch multiple entries at once.
|
|
497
|
+
- **The Azure, Bitbucket, Gitea/Forgejo and Git Gateway backends**: For performance reasons. [Git Gateway](https://github.com/netlify/git-gateway) has not been actively maintained since Netlify CMS was abandoned, and it’s known to be slow and prone to rate limit violations. We plan to develop a GraphQL-based high-performance alternative in the future. We may also support the other platforms if their APIs improve to allow the CMS to fetch multiple entries at once.
|
|
498
498
|
- **Netlify Identity Widget**: It’s not useful without Git Gateway, and Netlify Identity itself is now [deprecated](https://www.netlify.com/changelog/deprecation-netlify-identity/). We plan to develop an alternative solution with role support in the future, most likely using [Cloudflare Workers](https://workers.cloudflare.com/) and [Auth.js](https://authjs.dev/).
|
|
499
499
|
- The deprecated client-side implicit grant for the GitLab backend: It has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
500
500
|
- The deprecated Netlify Large Media service: Consider other storage providers.
|
|
501
501
|
- 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.
|
|
502
|
+
- 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.
|
|
502
503
|
- 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.
|
|
503
504
|
- Remark plugins: Not compatible with our Lexical-based rich text editor.
|
|
504
505
|
- [Undocumented methods](https://github.com/sveltia/sveltia-cms/blob/c69446da7bb0bab7405be741c0f92850c5dddfa8/src/main.js#L14-L37) exposed on the `window.CMS` object: This includes custom backends and custom media libraries, if any. We may support these features in the future, but our implementation would likely be incompatible with Netlify/Decap CMS.
|
|
505
506
|
- An absolute URL for the [`public_folder`](https://decapcms.org/docs/configuration-options/#public-folder) option: Such configuration is not recommended, as stated in the Netlify/Decap CMS document.
|
|
506
|
-
- 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](https://momentjs.com/) with [Day.js](https://day.js.org/), and Sveltia CMS will follow suit soon. Since [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) and [Day.js tokens](https://day.js.org/docs/en/display/format) are not 100% compatible, this could be a breaking change in certain cases.
|
|
507
507
|
|
|
508
508
|
### Current limitations
|
|
509
509
|
|
|
510
|
-
These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release
|
|
510
|
+
These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release.
|
|
511
511
|
|
|
512
512
|
- Comprehensive site config validation
|
|
513
513
|
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) other than English and Japanese
|
|
514
|
-
- [
|
|
515
|
-
- Field-specific media folders
|
|
514
|
+
- [Test](https://decapcms.org/docs/test-backend/) backend
|
|
515
|
+
- Field-specific media folders for the [File](https://decapcms.org/docs/widgets/#file) and [Image](https://decapcms.org/docs/widgets/#image) widgets
|
|
516
516
|
- [Map](https://decapcms.org/docs/widgets/#map) widget
|
|
517
517
|
- [Cloudinary](https://decapcms.org/docs/cloudinary/) and [Uploadcare](https://decapcms.org/docs/uploadcare/) media libraries
|
|
518
518
|
- [Custom widgets and custom editor components](https://decapcms.org/docs/custom-widgets/)
|
|
519
519
|
- [Custom previews](https://decapcms.org/docs/customization/)
|
|
520
520
|
- [Event subscriptions](https://decapcms.org/docs/registering-events/)
|
|
521
521
|
|
|
522
|
-
Due to the complexity, the following features
|
|
522
|
+
Due to the complexity, the following features will be added after the 1.0 release. Netlify/Decap CMS has a number of open issues with the collaboration and beta features — we want to implement them the right way.
|
|
523
523
|
|
|
524
524
|
- [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
525
525
|
- [Open Authoring](https://decapcms.org/docs/open-authoring/)
|
|
@@ -538,7 +538,7 @@ Sveltia CMS provides partial compatibility with [Static CMS](https://github.com/
|
|
|
538
538
|
- I18n support
|
|
539
539
|
- 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]`.
|
|
540
540
|
- Widgets
|
|
541
|
-
- The date/time format options for the DateTime widget
|
|
541
|
+
- The date/time format options for the DateTime widget are incompatible 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.
|
|
542
542
|
- The KeyValue widget is implemented in Sveltia CMS with the same options.
|
|
543
543
|
- The UUID widget is also implemented, but with different options.
|
|
544
544
|
- 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.
|
|
@@ -561,14 +561,18 @@ Currently, Sveltia CMS is primarily intended for existing Netlify/Decap CMS user
|
|
|
561
561
|
|
|
562
562
|
As the product evolves, we’ll implement a built-in configuration editor and provide comprehensive documentation to make it easier for everyone to get started with Sveltia CMS.
|
|
563
563
|
|
|
564
|
-
Here are some starter kits for popular frameworks created by community members. More to
|
|
564
|
+
Here are some starter kits for popular frameworks created by community members. More to come! (Note: These third-party resources are not necessarily reviewed by the Sveltia CMS team.)
|
|
565
565
|
|
|
566
|
-
-
|
|
567
|
-
- [
|
|
568
|
-
-
|
|
569
|
-
-
|
|
566
|
+
- 11ty
|
|
567
|
+
- [Eleventy starter template](https://github.com/danurbanowicz/eleventy-sveltia-cms-starter) by [@danurbanowicz](https://github.com/danurbanowicz)
|
|
568
|
+
- Astro
|
|
569
|
+
- [astro-sveltia-cms](https://github.com/majesticostudio/astro-sveltia-cms), [astro-starter](https://github.com/zankhq/astro-starter) and [astros](https://github.com/zankhq/astros) by [@zanhk](https://github.com/zanhk)
|
|
570
|
+
- [Astro i18n Starter](https://github.com/yacosta738/astro-cms) by [@yacosta738](https://github.com/yacosta738)
|
|
571
|
+
- Hugo
|
|
572
|
+
- [Hugo module](https://github.com/privatemaker/headless-cms) by [@privatemaker](https://github.com/privatemaker)
|
|
573
|
+
- [hugolify-sveltia-cms](https://github.com/Hugolify/hugolify-sveltia-cms/) by [@sebousan](https://github.com/sebousan)
|
|
570
574
|
|
|
571
|
-
|
|
575
|
+
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.
|
|
572
576
|
|
|
573
577
|
### Migration
|
|
574
578
|
|
|
@@ -665,7 +669,7 @@ Here are the workflow steps and tips:
|
|
|
665
669
|
|
|
666
670
|
Note that, as with Netlify/Decap CMS, the local repository support in Sveltia CMS doesn’t perform any Git operations. You’ll have to manually fetch, pull, commit and push all changes using a Git client. In the future, we’ll figure out if there’s a way to commit in a browser, because the proxy server actually has the undocumented, experimental `git` mode that creates commits to a local repository.[^131] ([Discussion](https://github.com/sveltia/sveltia-cms/discussions/31))
|
|
667
671
|
|
|
668
|
-
You will also need to reload the CMS after making changes to the configuration file or retrieving remote updates.
|
|
672
|
+
You will also need to reload the CMS after making changes to the configuration file or retrieving remote updates. We plan to eliminate this manual work with the newly available [File System Observer API](https://developer.chrome.com/blog/file-system-observer).
|
|
669
673
|
|
|
670
674
|
If you have migrated from Netlify/Decap CMS and are happy with the local repository workflow of Sveltia CMS, you can remove the `local_backend` property from your configuration and uninstall the proxy server. If you have configured a custom port number with the `.env` file, you can remove it as well.
|
|
671
675
|
|