@sveltia/cms 0.56.4 → 0.56.5
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 +11 -11
- package/dist/sveltia-cms.js +175 -175
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +172 -172
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -109,7 +109,7 @@ While Sveltia CMS is specifically designed to replace legacy Netlify CMS instanc
|
|
|
109
109
|
|
|
110
110
|
## Development status
|
|
111
111
|
|
|
112
|
-
Sveltia CMS is currently in **beta** and version 1.0 is expected to ship in **early 2025**, in time for the 10th anniversary of Netlify CMS development. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) for updates. See also our [roadmap](#roadmap).
|
|
112
|
+
Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in **early 2025**, in time for the 10th anniversary of Netlify CMS development. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) for updates. See also our [roadmap](#roadmap).
|
|
113
113
|
|
|
114
114
|
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:
|
|
115
115
|
|
|
@@ -117,7 +117,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
117
117
|
- Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
|
|
118
118
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
119
119
|
- So far, 165+ of them, or 330+ including duplicates, have been effectively solved in Sveltia CMS
|
|
120
|
-
- Target:
|
|
120
|
+
- Target: 200 by GA; 300, or 500 including duplicates, in the future
|
|
121
121
|
- 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 a fundamental solution, as well as [discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
122
122
|
- 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
|
|
123
123
|
- Solving [our own issues](https://github.com/sveltia/sveltia-cms/issues)
|
|
@@ -129,14 +129,14 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
129
129
|
|
|
130
130
|
## Differentiators
|
|
131
131
|
|
|
132
|
-
We hope Netlify/Decap CMS users will be pleased and surprised by the hundreds of
|
|
132
|
+
We hope Netlify/Decap CMS users will be pleased and surprised by the hundreds of improvements we have made, from the small to the large. Here’s what makes Sveltia CMS different. Look how serious we are!
|
|
133
133
|
|
|
134
134
|
### Better UX
|
|
135
135
|
|
|
136
136
|
- 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.
|
|
137
137
|
- The maintainer tries to be as responsive as possible. While there are no guarantees, the typical turnaround time for a bug fix is less than 24 hours.
|
|
138
138
|
- Offers a modern, intuitive user interface that utilizes the full viewport, inspired in part by the Netlify CMS v3 prototype.[^1][^178]
|
|
139
|
-
- Immersive dark mode is available.[^2]
|
|
139
|
+
- Immersive dark mode is available.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
|
|
140
140
|
- 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.
|
|
141
141
|
- 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 React application crashes.[^113][^129] Best of all, Svelte offers great performance.
|
|
142
142
|
- We develop [our own UI library](https://github.com/sveltia/sveltia-ui) to ensure optimal usability without compromising accessibility.
|
|
@@ -149,7 +149,7 @@ We hope Netlify/Decap CMS users will be pleased and surprised by the hundreds of
|
|
|
149
149
|
- Built completely from scratch with [Svelte](https://svelte.dev/) 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 or static site generator (SSG) that can load static data files during the build process.
|
|
150
150
|
- Small footprint: The bundle size is less than 500 KB when minified and [brotlied](https://en.wikipedia.org/wiki/Brotli), which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.7 MB) and Static CMS (2.6 MB),[^57][^64] even though we haven’t implemented some features yet, but rather added many new features. That’s the power of Svelte + [Vite](https://vite.dev/).
|
|
151
151
|
- We have upgraded from Svelte 4 to [Svelte 5](https://svelte.dev/blog/svelte-5-is-alive) to further improve performance, including an even smaller bundle size. A full migration to the Runes reactivity API is underway.
|
|
152
|
-
- Sveltia CMS is free of technical debt (except for the Moment.js dependency, which will
|
|
152
|
+
- Sveltia CMS is free of technical debt (except for the Moment.js dependency, which will be replaced by Day.js before GA) and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
153
153
|
- 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] (the useless `search` configuration option is therefore ignored). It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets.[^14]
|
|
154
154
|
- 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/).
|
|
155
155
|
- Our [local repository workflow](#working-with-a-local-git-repository) utilizes the modern [File System Access API](https://developer.chrome.com/articles/file-system-access/) to read and write files natively through the web browser, rather than using a slow, ad hoc REST API through a proxy server.
|
|
@@ -499,15 +499,15 @@ These limitations are expected to be resolved before the 1.0 release scheduled f
|
|
|
499
499
|
|
|
500
500
|
| Widget | Status in Sveltia CMS |
|
|
501
501
|
| --- | --- |
|
|
502
|
-
| [Code](https://decapcms.org/docs/widgets/#code) |
|
|
502
|
+
| [Code](https://decapcms.org/docs/widgets/#code) | Not yet implemented. |
|
|
503
503
|
| [DateTime](https://decapcms.org/docs/widgets/#datetime) | The `date_format` and `time_format` options with Moment.js tokens are not yet supported. Note that [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 [Decap CMS 3.3.0](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.3.0) made other changes to the widget behaviour; we’ll follow these changes where it makes sense. |
|
|
504
504
|
| [File](https://decapcms.org/docs/widgets/#file) / [Image](https://decapcms.org/docs/widgets/#image) | Field-specific media folders (beta) and media library options are not yet supported other than `media_library.config.max_file_size` for the default media library. |
|
|
505
|
-
| [Map](https://decapcms.org/docs/widgets/#map) |
|
|
505
|
+
| [Map](https://decapcms.org/docs/widgets/#map) | Not yet implemented. |
|
|
506
506
|
| [Markdown](https://decapcms.org/docs/widgets/#markdown) | Custom components are not yet supported. There is no language selector yet in the built-in `code-block` component. |
|
|
507
507
|
|
|
508
508
|
### Features to be implemented after GA
|
|
509
509
|
|
|
510
|
-
Due to the complexity, the following features are planned for after the 1.0 release. Netlify/Decap CMS has a number of open issues with these collaboration and beta features
|
|
510
|
+
Due to the complexity, the following features are planned for after the 1.0 release. Netlify/Decap CMS has a number of open issues with these collaboration and beta features — we want to implement them the right way.
|
|
511
511
|
|
|
512
512
|
- [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
513
513
|
- [Open Authoring](https://decapcms.org/docs/open-authoring/)
|
|
@@ -520,7 +520,7 @@ We plan to provide partial compatibility with [Static CMS](https://github.com/St
|
|
|
520
520
|
- Configuration options
|
|
521
521
|
- 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.
|
|
522
522
|
- The `default` option for sortable fields is [implemented in Sveltia CMS](#specifying-default-sort-field-and-direction).
|
|
523
|
-
- 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
|
|
523
|
+
- 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))
|
|
524
524
|
- The `logo_link` global option will not be supported. Use `display_url` or `site_url` instead.
|
|
525
525
|
- The `yaml` global option will not be supported, as Sveltia CMS doesn’t expose the `yaml` library options directly for forward compatibility reasons. However, we do have some [data output options](#controlling-data-output), including YAML indentation and quotes.
|
|
526
526
|
- I18n support
|
|
@@ -528,8 +528,8 @@ We plan to provide partial compatibility with [Static CMS](https://github.com/St
|
|
|
528
528
|
- Widgets
|
|
529
529
|
- The KeyValue widget is implemented in Sveltia CMS with the same options.
|
|
530
530
|
- The UUID widget is also implemented, but with different options.
|
|
531
|
-
- The `prefix` and `suffix` options for the Boolean, Number and String widgets are implemented as `before_input` and `after_input
|
|
532
|
-
- The `multiple` option for the File and Image widgets will be implemented in Sveltia CMS
|
|
531
|
+
- The `prefix` and `suffix` options for the Boolean, Number and String widgets are implemented as `before_input` and `after_input`, respectively, in Sveltia CMS. Our `prefix` and `suffix` options for the String widget are literally a prefix and suffix to the value.
|
|
532
|
+
- 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))
|
|
533
533
|
- Customization
|
|
534
534
|
- `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.
|
|
535
535
|
|