@sveltia/cms 0.39.2 → 0.39.4
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 +15 -14
- package/dist/sveltia-cms.js +285 -287
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +284 -286
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -70,15 +70,15 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
70
70
|
|
|
71
71
|
- Created and maintained by an [experienced UX engineer](https://github.com/kyoshino) who loves code, design and marketing. You can expect constant improvements to the user experience (UX) and developer experience (DX) across the platform.
|
|
72
72
|
- Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
|
|
73
|
-
- Comes with touch device support,
|
|
73
|
+
- Comes with touch device support, such as larger buttons for easier tapping. While the UI is not yet optimized for small screens, it should work well with large tablets like iPad Pro or Pixel Tablet. Mobile support and other optimizations such as swipe navigation are planned after the 1.0 release.
|
|
74
74
|
- Made with Svelte, not React, means we can spend more time on UX rather than tedious state management. It also allows us to avoid common fatal application crashes[^113]. Best of all, Svelte offers unmatched performance!
|
|
75
75
|
- The screenshots above are worth a thousand words, but read on to learn about many other improvements in detail.
|
|
76
76
|
|
|
77
77
|
### Better performance
|
|
78
78
|
|
|
79
79
|
- Built completely from scratch with Svelte instead of forking React-based Netlify/Decap CMS. The app starts fast and stays fast. The compiled code is vanilla JavaScript — you can use it with any framework that can load static data files while building your website or application.
|
|
80
|
-
- Small footprint: The bundle size is less than 450 KB when minified and gzipped, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.8 MB) and Static CMS (2.6 MB), even though we haven’t implemented some features yet
|
|
81
|
-
- We have upgraded from Svelte 4 to [Svelte 5 Release Candidate](https://svelte.dev/blog/svelte-5-release-candidate) to further boost performance,
|
|
80
|
+
- Small footprint: The bundle size is less than 450 KB when minified and gzipped, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.8 MB) and Static CMS (2.6 MB)[^57][^64], even though we haven’t implemented some features yet. That’s the power of Svelte + Vite.
|
|
81
|
+
- We have upgraded from Svelte 4 to [Svelte 5 Release Candidate](https://svelte.dev/blog/svelte-5-release-candidate) to further boost performance, resulting in faster rendering, reduced memory usage and even smaller bundle size. A full migration to the _runes_ reactivity API will follow.
|
|
82
82
|
- Sveltia CMS is free of technical debt and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
83
83
|
- Uses the GraphQL API for GitHub and GitLab to quickly fetch content at once, so that entries and assets can be listed and searched instantly[^32][^65]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
|
|
84
84
|
- Saving entries and assets to GitHub is also much faster thanks to the [GraphQL mutation](https://github.blog/changelog/2021-09-13-a-simpler-api-for-authoring-commits/).
|
|
@@ -255,6 +255,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
255
255
|
- Supports the `prefix` and `suffix` string options, which automatically prepend and/or append the developer-defined value to the user-input value.
|
|
256
256
|
- Boolean, Number and String
|
|
257
257
|
- Supports the `before_input` and `after_input` string options, which allow developers to display custom labels before and/or after the input UI[^28]. Markdown is supported in the value.
|
|
258
|
+
- _Compatibility note_: In Static CMS, these options are implemented as `prefix` and `suffix`, respectively.
|
|
258
259
|
- File and Image
|
|
259
260
|
- Provides a reimagined all-in-one asset selection dialog for File and Image fields.
|
|
260
261
|
- [Collection-specific assets](#using-a-custom-media-folder-for-a-collection) are listed for easy selection, while all assets are displayed in a separate tab[^19].
|
|
@@ -308,6 +309,16 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
308
309
|
|
|
309
310
|
We are trying to make Sveltia CMS compatible with Netlify/Decap CMS where possible, so that more users can seamlessly switch to our modern, powerful, high performance alternative. However, some features will be omitted due to deprecations and other factors.
|
|
310
311
|
|
|
312
|
+
### Features not to be implemented
|
|
313
|
+
|
|
314
|
+
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported** for performance reasons. We may implement a high-performance Git Gateway alternative in the future. We may also support the other services if/when their APIs improve to allow the CMS to fetch multiple files at once.
|
|
315
|
+
- **The Netlify Identity Widget will not be supported**, as it’s not useful without Git Gateway. We may be able to support it in the future if/when a Git Gateway alternative is created.
|
|
316
|
+
- The deprecated client-side implicit grant for the GitLab backend will not be supported, as it has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
317
|
+
- The deprecated Netlify Large Media service will not be supported. Consider other storage providers.
|
|
318
|
+
- The deprecated Date widget will not be supported, as it has already been removed from Decap CMS 3.0. Use the DateTime widget instead.
|
|
319
|
+
- Remark plugins will not be supported, as they are not compatible with our Lexical-based rich text editor.
|
|
320
|
+
- [Undocumented methods](https://github.com/sveltia/sveltia-cms/blob/c69446da7bb0bab7405be741c0f92850c5dddfa8/src/main.js#L14-L37) exposed on the `window.CMS` object will not be implemented. This includes custom backends and custom media libraries, if any.
|
|
321
|
+
|
|
311
322
|
### Current limitations
|
|
312
323
|
|
|
313
324
|
These limitations are expected to be resolved before or shortly after GA:
|
|
@@ -333,22 +344,13 @@ These limitations are expected to be resolved before or shortly after GA:
|
|
|
333
344
|
|
|
334
345
|
Missing any other features? Let us know by [filing an issue](https://github.com/sveltia/sveltia-cms/issues/new).
|
|
335
346
|
|
|
336
|
-
### Features not to be implemented
|
|
337
|
-
|
|
338
|
-
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported** for performance reasons. We may implement a high-performance Git Gateway alternative in the future. We may also support the other services if/when their APIs improve to allow the CMS to fetch multiple files at once.
|
|
339
|
-
- The Netlify Identity Widget will not be supported, as it’s not useful without Git Gateway. We may be able to support it in the future if/when a Git Gateway alternative is created.
|
|
340
|
-
- The deprecated client-side implicit grant for the GitLab backend will not be supported, as it has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
341
|
-
- The deprecated Netlify Large Media service will not be supported. Consider other storage providers.
|
|
342
|
-
- Sveltia CMS has dropped the support for the deprecated Date widget following Decap CMS 3.0. Use the DateTime widget instead.
|
|
343
|
-
- Remark plugins will not be supported, as they are not compatible with our Lexical-based rich text editor.
|
|
344
|
-
- [Undocumented methods](https://github.com/sveltia/sveltia-cms/blob/6b8a86174f9beb4acc4bddcaa3848f773c1b2e52/src/main.js#L13-L36) exposed on the `window.CMS` object will not be implemented. This includes custom backends and custom media libraries, if any.
|
|
345
|
-
|
|
346
347
|
## Roadmap
|
|
347
348
|
|
|
348
349
|
### Before the 1.0 release
|
|
349
350
|
|
|
350
351
|
- [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) _runes_ migration
|
|
351
352
|
- Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
|
|
353
|
+
- Certain compatibility with Static CMS, a now-discontinued community fork of Netlify CMS, including the [KeyValue widget](https://staticjscms.netlify.app/docs/widget-keyvalue)[^123]
|
|
352
354
|
- Localization with the new [Fluent](https://projectfluent.org)-powered sveltia-i18n library
|
|
353
355
|
- Accessibility audit
|
|
354
356
|
- Developer documentation (implementation guide)
|
|
@@ -360,7 +362,6 @@ Missing any other features? Let us know by [filing an issue](https://github.com/
|
|
|
360
362
|
### After the 1.0 release
|
|
361
363
|
|
|
362
364
|
- Tackling more Netlify/Decap CMS issues, especially the [top voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including MDX support[^122], manual entry sorting[^125], roles[^23], mobile optimization[^18] and config editor[^10] — Some features are already implemented in Sveltia CMS
|
|
363
|
-
- Certain compatibility with Static CMS, a now-discontinued community fork of Netlify CMS, including the [KeyValue widget](https://staticjscms.netlify.app/docs/widget-keyvalue)[^123]
|
|
364
365
|
- Advanced digital asset management (DAM) features, including image editing and tagging[^114]
|
|
365
366
|
- AI integrations
|
|
366
367
|
- End-user documentation
|