@sveltia/cms 0.53.5 → 0.53.6
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 +17 -10
- package/dist/sveltia-cms.js +2 -2
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +2 -2
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -100,7 +100,7 @@ While Sveltia CMS is specifically designed to replace legacy Netlify CMS instanc
|
|
|
100
100
|
### Our goals
|
|
101
101
|
|
|
102
102
|
- Making Sveltia CMS a viable, definitive successor to Netlify CMS
|
|
103
|
-
- Empowering small businesses and individuals who need a simple, free, yet powerful CMS solution
|
|
103
|
+
- Empowering small businesses and individuals who need a simple, free, yet powerful, high-quality CMS solution
|
|
104
104
|
- Emerging as the leading open source offering in the Git-based CMS market
|
|
105
105
|
- Extending its capabilities as digital asset management (DAM) software
|
|
106
106
|
- Showcasing the power of Svelte and UX engineering
|
|
@@ -112,10 +112,11 @@ Sveltia CMS is currently in **beta** and version 1.0 is expected to ship in **ea
|
|
|
112
112
|
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:
|
|
113
113
|
|
|
114
114
|
- Ensuring substantial [compatibility with Netlify/Decap CMS](#compatibility)
|
|
115
|
+
- Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
|
|
115
116
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
116
|
-
- So far,
|
|
117
|
+
- So far, 160+ of them, or 305+ including duplicates, have been effectively solved in Sveltia CMS
|
|
117
118
|
- Target: 300 or all relevant, fixable and worthwhile issues in the future; 500 including duplicates
|
|
118
|
-
- Note: Issues include feature requests, bug reports, [stale issues](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) and [discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
119
|
+
- Note: Issues include feature requests, bug reports, [“closed as stale” issues](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) and [discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
119
120
|
- 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
|
|
120
121
|
- Solving [our own issues](https://github.com/sveltia/sveltia-cms/issues)
|
|
121
122
|
- Implementing our own enhancement ideas for every part of the product
|
|
@@ -143,8 +144,8 @@ We hope Netlify/Decap CMS users will be pleased and surprised by the hundreds of
|
|
|
143
144
|
### Better performance
|
|
144
145
|
|
|
145
146
|
- 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 or static site generator (SSG) that can load static data files during the build process.
|
|
146
|
-
- Small footprint: The bundle size is less than 500 KB when minified and brotlied, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.
|
|
147
|
-
- 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
|
|
147
|
+
- 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.
|
|
148
|
+
- 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.
|
|
148
149
|
- Sveltia CMS is free of technical debt (except for Moment.js, which will soon be replaced by Day.js) and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
149
150
|
- 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 ignored). It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
|
|
150
151
|
- 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/).
|
|
@@ -239,6 +240,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
239
240
|
- Raises a validation error instead of failing silently if the `single_file` structure is used and a required field is not filled in any of the locales[^55].
|
|
240
241
|
- Fields in non-default locales are validated as expected[^13].
|
|
241
242
|
- No internal error is thrown when changing the locale[^103].
|
|
243
|
+
- Duplicating an entry duplicates all locale content, not just the default locale[^170].
|
|
242
244
|
|
|
243
245
|
### Better collections
|
|
244
246
|
|
|
@@ -350,7 +352,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
350
352
|
- Users can preview variable types without having to register a preview template[^42].
|
|
351
353
|
- It’s possible to omit `fields` in a variable type object[^163]. In that case only the `typeKey` (default: `type`) is saved in the output.
|
|
352
354
|
- Markdown
|
|
353
|
-
- The rich text editor is built with the well-maintained [Lexical](https://lexical.dev/) framework, which solves various issues with a [Slate](https://github.com/ianstormtaylor/slate)-based editor in Netlify/Decap CMS, including fatal application crashes[^71][^72][^73][^111], lost formatting when pasting[^124], backslash injections[^53], dropdown visibility[^70], and text input difficulties with IME[^54].
|
|
355
|
+
- The rich text editor is built with the well-maintained [Lexical](https://lexical.dev/) framework, which solves various issues with a [Slate](https://github.com/ianstormtaylor/slate)-based editor in Netlify/Decap CMS, including fatal application crashes[^71][^72][^73][^111], lost formatting when pasting[^124], an extra line break when pasting[^169], backslash injections[^53], dropdown visibility[^70], and text input difficulties with IME[^54].
|
|
354
356
|
- The default editor mode can be set by changing the order of the `modes` option[^58]. If you want to use the plain text editor by default, add `modes: [raw, rich_text]` to the field configuration.
|
|
355
357
|
- A combination of bold and italic doesn’t create a confusing 3-asterisk markup[^160]. In our editor, bold is 2 asterisks and italic is an underscore.
|
|
356
358
|
- The built-in `image` component can be inserted with a single click.
|
|
@@ -470,7 +472,7 @@ However, 100% feature parity is not planned, and some features are still missing
|
|
|
470
472
|
|
|
471
473
|
### Features to be implemented before GA
|
|
472
474
|
|
|
473
|
-
These limitations are expected to be resolved before the 1.0 release:
|
|
475
|
+
These limitations are expected to be resolved before the 1.0 release scheduled for early 2025:
|
|
474
476
|
|
|
475
477
|
| Feature | Status in Sveltia CMS |
|
|
476
478
|
| --- | --- |
|
|
@@ -487,7 +489,7 @@ These limitations are expected to be resolved before the 1.0 release:
|
|
|
487
489
|
| [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. |
|
|
488
490
|
| [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. |
|
|
489
491
|
| [Map](https://decapcms.org/docs/widgets/#map) | Coming soon. |
|
|
490
|
-
| [Markdown](https://decapcms.org/docs/widgets/#markdown) | Custom components are not yet supported. There is no language
|
|
492
|
+
| [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. |
|
|
491
493
|
|
|
492
494
|
### Features to be implemented after GA
|
|
493
495
|
|
|
@@ -503,7 +505,7 @@ We plan to provide partial compatibility with [Static CMS](https://github.com/St
|
|
|
503
505
|
|
|
504
506
|
- Configuration options
|
|
505
507
|
- Static CMS made [some breaking changes](https://staticjscms.netlify.app/docs/decap-migration-guide) to sortable fields, view filters/groups, List widget, etc. while Sveltia CMS follows Netlify/Decap CMS, so you should review your configuration carefully.
|
|
506
|
-
- The `default` option for sortable fields
|
|
508
|
+
- The `default` option for sortable fields will be implemented in Sveltia CMS soon. ([#304](https://github.com/sveltia/sveltia-cms/issues/304))
|
|
507
509
|
- 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 soon. 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))
|
|
508
510
|
- The `logo_link` global option will not be supported. Use `display_url` or `site_url` instead.
|
|
509
511
|
- 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.
|
|
@@ -1016,6 +1018,7 @@ See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/ma
|
|
|
1016
1018
|
### Before the 1.0 release
|
|
1017
1019
|
|
|
1018
1020
|
- Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
|
|
1021
|
+
- Tackling some more Netlify/Decap CMS issues
|
|
1019
1022
|
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md)
|
|
1020
1023
|
- Accessibility audit
|
|
1021
1024
|
- Developer documentation (implementation guide)
|
|
@@ -1027,7 +1030,7 @@ See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/ma
|
|
|
1027
1030
|
### After the 1.0 release
|
|
1028
1031
|
|
|
1029
1032
|
- Implementing the [remaining Netlify/Decap CMS features](#features-to-be-implemented-after-ga)
|
|
1030
|
-
- Tackling more Netlify/Decap CMS issues, including MDX support[^122], manual entry sorting[^125], mobile optimization[^18], config editor[^10] and other [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
1033
|
+
- Tackling even more Netlify/Decap CMS issues, including MDX support[^122], manual entry sorting[^125], mobile optimization[^18], config editor[^10] and other [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
1031
1034
|
- Exploring features that require server-side implementation, including user management (Netlify Identity alternative), roles[^23], commits without a GitHub or GitLab account (Git Gateway alternative), post locking (like [WordPress](https://codex.wordpress.org/Post_Locking))[^166] and scheduled posts[^167]
|
|
1032
1035
|
- Considering further [compatibility with Static CMS](#compatibility-with-static-cms)
|
|
1033
1036
|
- More integration options: stock photos, stock videos, cloud storage providers, translation services, maps, analytics tools
|
|
@@ -1389,3 +1392,7 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
1389
1392
|
[^167]: Netlify/Decap CMS [#263](https://github.com/decaporg/decap-cms/issues/263)
|
|
1390
1393
|
|
|
1391
1394
|
[^168]: Netlify/Decap CMS [#1948](https://github.com/decaporg/decap-cms/issues/1948)
|
|
1395
|
+
|
|
1396
|
+
[^169]: Netlify/Decap CMS [#7364](https://github.com/decaporg/decap-cms/issues/7364)
|
|
1397
|
+
|
|
1398
|
+
[^170]: Netlify/Decap CMS [#7371](https://github.com/decaporg/decap-cms/issues/7371)
|