@sveltia/cms 0.119.2 → 0.120.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 +42 -26
- package/dist/sveltia-cms.js +201 -201
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +203 -203
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +2 -2
- package/schema/sveltia-cms.json +1 -1
- package/types/public.d.ts +2 -2
package/README.md
CHANGED
|
@@ -127,25 +127,32 @@ Due to its unfortunate abandonment in early 2022, Netlify CMS spawned 3 successo
|
|
|
127
127
|
- **Sveltia CMS**: not a fork but a **complete rewrite**
|
|
128
128
|
- Started in November 2022, first appeared on GitHub in March 2023
|
|
129
129
|
- ✅ Actively developed with frequent releases and numerous improvements
|
|
130
|
-
- ✅
|
|
130
|
+
- ✅ Relevant issues are actively being addressed regardless of their age or status
|
|
131
|
+
- ✅ Most of bug reports are addressed promptly, usually within a day
|
|
132
|
+
- ✅ No known unpatched security vulnerabilities, with dependencies kept up-to-date
|
|
131
133
|
- [Decap CMS](https://github.com/decaporg/decap-cms): a rebranded version
|
|
132
134
|
- [Announced in February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/) as an official continuation with a Netlify agency partner taking ownership
|
|
133
135
|
- ⚠️ Mostly low activity with only occasional releases and a few minor improvements
|
|
134
|
-
-
|
|
136
|
+
- ⚠️ Seemingly random issues were closed as stale following the rebranding
|
|
137
|
+
- ⚠️ Bug reports continue to pile up, often without any response
|
|
138
|
+
- ❌ A moderate severity [XSS vulnerability](https://github.com/advisories/GHSA-xp8g-32qh-mv28), high severity dependency vulnerabilities and fatal crashes remain unaddressed
|
|
135
139
|
|
|
136
140
|
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**:
|
|
137
141
|
|
|
138
|
-
- We
|
|
142
|
+
- We rebuilt the app from scratch using a [modern framework](https://svelte.dev/)
|
|
139
143
|
- We don’t reuse any part of the predecessor’s codebase
|
|
140
144
|
- We incorporate i18n support into the core instead of adding it as an afterthought
|
|
141
145
|
- We closely monitor and analyze the predecessor’s issue tracker
|
|
142
146
|
- We rearchitect the entire user experience (UX) and developer experience (DX)
|
|
143
147
|
|
|
144
|
-
This “total reboot”
|
|
148
|
+
This “total reboot” has enabled us to implement hundreds of improvements without getting stuck in a legacy system. We are fully committed to making Sveltia CMS the best successor to Netlify CMS:
|
|
145
149
|
|
|
146
|
-
|
|
150
|
+
- We dedicate significant time and effort to modernizing the platform
|
|
151
|
+
- We continue to address [issues](https://github.com/decaporg/decap-cms/issues) reported in the predecessor’s repository
|
|
152
|
+
- We materialize the enhancements that Netlify CMS users have long desired
|
|
153
|
+
- We deliver [regular updates](https://github.com/sveltia/sveltia-cms/releases) and [clear goals](#roadmap)
|
|
147
154
|
|
|
148
|
-
|
|
155
|
+
For that reason, Sveltia CMS is the **true successor to Netlify CMS** — not just a spiritual successor or a mere alternative — and the best choice for users looking to migrate from the predecessor, other successors, or even other CMS solutions.
|
|
149
156
|
|
|
150
157
|
### Our goals
|
|
151
158
|
|
|
@@ -168,9 +175,14 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
168
175
|
- So far, **270+ issues, or 580+ if including duplicates, have been effectively solved** in Sveltia CMS (Yes, you read it right)
|
|
169
176
|
- Target:
|
|
170
177
|
- 250 issues, or 500 if including duplicates, by GA — We did it! 🎉
|
|
171
|
-
-
|
|
178
|
+
- 450 issues, or 900 if including duplicates, in the future 💪
|
|
172
179
|
- or every single issue that’s relevant, fixable, and worth dealing with 🔥
|
|
173
|
-
- Issues include everything
|
|
180
|
+
- Issues include everything:
|
|
181
|
+
- Outstanding issues from feature requests to bug reports
|
|
182
|
+
- [Issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22)
|
|
183
|
+
- Issues closed without an optimal solution
|
|
184
|
+
- [Discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
185
|
+
- Stalled [pull requests](https://github.com/decaporg/decap-cms/pulls)
|
|
174
186
|
- Many of the bugs, including the annoying crashes, have already been solved
|
|
175
187
|
- The remaining bugs are mostly related to [unimplemented features](#current-limitations)
|
|
176
188
|
- 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](#roadmap) or already implemented in Sveltia CMS
|
|
@@ -329,6 +341,7 @@ The [GitHub](https://decapcms.org/docs/github-backend/), [GitLab](https://decapc
|
|
|
329
341
|
- An indicator is displayed in the account menu when using the local repository workflow.[^302]
|
|
330
342
|
- Developers can select the local and remote backends while working on a local server.
|
|
331
343
|
- 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
|
+
- Commit message template supports the `{{author-email}}` template tag to include the author’s email address.
|
|
332
345
|
|
|
333
346
|
### Better i18n support
|
|
334
347
|
|
|
@@ -505,6 +518,7 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
|
|
|
505
518
|
- `{{locale}}`: The current locale code.[^101]
|
|
506
519
|
- `{{datetime}}`: The current date/time in [ISO 8601 format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format).[^102]
|
|
507
520
|
- `{{uuid}}`, `{{uuid_short}}` and `{{uuid_shorter}}`: A random UUID or its shorter version, just like the [slug template tags](#using-a-random-id-for-an-entry-slug).[^12]
|
|
521
|
+
- `{{author-email}}`, `{{author-login}}` and `{{author-name}}`: The signed-in user’s email, login name and display name, respectively.[^305]
|
|
508
522
|
- The `default` value is saved when you create a file collection item, not just a folder collection item.[^78]
|
|
509
523
|
- List
|
|
510
524
|
- It’s possible to [edit data files with a top-level list](#editing-data-files-with-a-top-level-list) using the new `root` option.[^148]
|
|
@@ -683,20 +697,17 @@ However, 100% feature parity is never planned, and some features are still missi
|
|
|
683
697
|
|
|
684
698
|
There are still some missing features and limitations in Sveltia CMS compared to Netlify/Decap CMS. We are working hard to implement them. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
|
|
685
699
|
|
|
686
|
-
The following advanced customization features are not yet implemented and will be added before the 1.0 release:
|
|
687
|
-
|
|
688
|
-
-
|
|
689
|
-
- [Custom
|
|
690
|
-
- [
|
|
691
|
-
- [
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
698
|
-
- [Open authoring](https://decapcms.org/docs/open-authoring/)
|
|
699
|
-
- [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
|
|
700
|
+
- The following advanced customization features are not yet implemented and will be added before the 1.0 release:
|
|
701
|
+
- Preview for [custom editor components](https://decapcms.org/docs/custom-widgets/#registereditorcomponent) (`CMS.registerEditorComponent`)
|
|
702
|
+
- [Custom widgets](https://decapcms.org/docs/custom-widgets/) (`CMS.registerWidget`)
|
|
703
|
+
- [Custom preview templates](https://decapcms.org/docs/customization/#registerpreviewtemplate) (`CMS.registerPreviewTemplate`) ([#51](https://github.com/sveltia/sveltia-cms/issues/51))
|
|
704
|
+
- [Event hooks](https://decapcms.org/docs/registering-events/) (`CMS.registerEventListener`) ([#167](https://github.com/sveltia/sveltia-cms/issues/167))
|
|
705
|
+
- [Documentation](https://github.com/sveltia/sveltia-cms/issues/485) and site config validation are also under development.
|
|
706
|
+
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) and a [demo site](https://github.com/sveltia/sveltia-cms/issues/1) will follow soon.
|
|
707
|
+
- Due to the complexity, we have decided to **defer the following features to the 1.x or 2.0 release** due mid-2026. Netlify/Decap CMS has dozens of open issues with these collaboration and beta features — we want to implement them the right way.
|
|
708
|
+
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
709
|
+
- [Open authoring](https://decapcms.org/docs/open-authoring/)
|
|
710
|
+
- [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
|
|
700
711
|
|
|
701
712
|
### Features not to be implemented
|
|
702
713
|
|
|
@@ -827,9 +838,10 @@ Unfortunately, **we are unable to provide installation and setup support** at th
|
|
|
827
838
|
|
|
828
839
|
### Migration
|
|
829
840
|
|
|
830
|
-
<!-- prettier-ignore -->
|
|
841
|
+
<!-- prettier-ignore-start -->
|
|
831
842
|
> [!IMPORTANT]
|
|
832
843
|
> Take a look at the [compatibility info](#compatibility) above first. Some Netlify/Decap CMS features are not yet implemented or will not be added to Sveltia CMS, meaning you may not be able to migrate right away.
|
|
844
|
+
<!-- prettier-ignore-end -->
|
|
833
845
|
|
|
834
846
|
If you’re already using Netlify/Decap CMS with the GitHub, GitLab or Gitea/Forgejo backend and don’t have any unsupported features like editorial workflow or nested collections, migrating to Sveltia CMS is super easy — it works as a drop-in replacement.
|
|
835
847
|
|
|
@@ -1973,15 +1985,17 @@ While we don’t have dedicated developer/user support resources, you can post [
|
|
|
1973
1985
|
|
|
1974
1986
|
Join us on [Discord](https://discord.gg/5hwCGqup5b) or ping us on [Bluesky](https://bsky.app/profile/sveltiacms.app) for a casual chat.
|
|
1975
1987
|
|
|
1976
|
-
<!-- prettier-ignore -->
|
|
1988
|
+
<!-- prettier-ignore-start -->
|
|
1977
1989
|
> [!IMPORTANT]
|
|
1978
1990
|
> As described throughout this README, Sveltia CMS is specifically designed as a replacement for Netlify/Decap CMS. At this point, we assume that most developers and users are moving from the other product. We are happy to help you migrate, but **we cannot help you set up Sveltia CMS from scratch** through our free support channels.
|
|
1991
|
+
<!-- prettier-ignore-end -->
|
|
1979
1992
|
|
|
1980
1993
|
Planning to build a website with Sveltia CMS? Looking for professional support? Maintainer [@kyoshino](https://github.com/kyoshino) is available for hire depending on your needs. Feel free to reach out!
|
|
1981
1994
|
|
|
1982
|
-
<!-- prettier-ignore -->
|
|
1995
|
+
<!-- prettier-ignore-start -->
|
|
1983
1996
|
> [!IMPORTANT]
|
|
1984
1997
|
> Please do not email the maintainer for free support. Your emails will be ignored. Instead, use the [Discussions](https://github.com/sveltia/sveltia-cms/discussions) page.
|
|
1998
|
+
<!-- prettier-ignore-end -->
|
|
1985
1999
|
|
|
1986
2000
|
## Contributions
|
|
1987
2001
|
|
|
@@ -2035,7 +2049,7 @@ Due late 2026
|
|
|
2035
2049
|
|
|
2036
2050
|
### TBD
|
|
2037
2051
|
|
|
2038
|
-
- Tackling
|
|
2052
|
+
- Tackling the remaining relevant Netlify/Decap CMS issues (some may be included in v2.0 or v3.0):
|
|
2039
2053
|
- Their [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including:
|
|
2040
2054
|
- MDX support[^122]
|
|
2041
2055
|
- [Saving drafts without editorial workflow](https://github.com/sveltia/sveltia-cms/discussions/440)[^261]
|
|
@@ -2718,3 +2732,5 @@ This project would not have been possible without the open source Netlify CMS pr
|
|
|
2718
2732
|
[^303]: Netlify/Decap CMS [#3803](https://github.com/decaporg/decap-cms/issues/3803)
|
|
2719
2733
|
|
|
2720
2734
|
[^304]: Netlify/Decap CMS [#4538](https://github.com/decaporg/decap-cms/issues/4538), [#6371](https://github.com/decaporg/decap-cms/issues/6371)
|
|
2735
|
+
|
|
2736
|
+
[^305]: Netlify/Decap CMS [#1483](https://github.com/decaporg/decap-cms/issues/1483)
|