@sveltia/cms 0.114.0 → 0.115.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 +23 -10
- package/dist/sveltia-cms.js +229 -229
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +162 -162
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
- package/schema/sveltia-cms.json +14 -0
- package/types/public.d.ts +9 -0
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Sveltia CMS: Netlify/Decap CMS successor
|
|
2
2
|
|
|
3
|
-
Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, powerful, direct replacement for Netlify CMS (now Decap CMS).
|
|
3
|
+
Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, powerful, direct replacement for Netlify CMS (now Decap CMS). We have picked up where they left off and have already solved over 265 issues reported in the predecessor’s repository, ranging from critical bugs to top feature requests.
|
|
4
4
|
|
|
5
|
-
Built from the ground up, Sveltia CMS offers excellent UX, DX, performance, security and internationalization (i18n) support.
|
|
5
|
+
Built from the ground up, Sveltia CMS offers excellent UX, DX, performance, security and internationalization (i18n) support. Although some features are still missing, our numerous enhancements across the board ensure smooth daily workflows.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
This free, open source successor to Netlify/Decap CMS is currently in public beta, with version 1.0 expected in early 2026.
|
|
8
8
|
|
|
9
9
|
<br>
|
|
10
10
|
|
|
@@ -140,9 +140,9 @@ Sveltia CMS is the only project that doesn’t inherit the complexity, technical
|
|
|
140
140
|
- We closely monitor and analyze the predecessor’s issue tracker
|
|
141
141
|
- We rearchitect the entire user experience (UX) and developer experience (DX)
|
|
142
142
|
|
|
143
|
-
This “total reboot” allows us to implement [hundreds of improvements](#differentiators) without getting stuck in a legacy system
|
|
143
|
+
This “total reboot” allows us to implement [hundreds of improvements](#differentiators) without getting stuck in a legacy system.
|
|
144
144
|
|
|
145
|
-
|
|
145
|
+
We are continuing to address the [issues](https://github.com/decaporg/decap-cms/issues) reported in the predecessor’s repository and deliver the enhancements that Netlify CMS users have desired for a long time. Of the 3 successors, only Sveltia CMS is receiving consistent, outstanding development, with [regular updates](https://github.com/sveltia/sveltia-cms/releases) and a [clear roadmap](#roadmap). For that reason, Sveltia CMS is the **true successor to Netlify CMS** — not just a spiritual successor or a mere alternative.
|
|
146
146
|
|
|
147
147
|
### Our goals
|
|
148
148
|
|
|
@@ -283,6 +283,7 @@ We’ve made various improvements to help you get your work done faster and more
|
|
|
283
283
|
- Also supports [multiple configuration files](#providing-multiple-configuration-files) to allow developers to modularize the configuration.[^197]
|
|
284
284
|
- We provide an [up-to-date JSON schema](#enabling-autocomplete-and-validation-for-the-configuration-file) for YAML/JSON configuration files, which enables autocomplete and validation in VS Code and other editors.[^253] If you use [deprecated options](#deprecations) in a supported code editor, you should receive a warning.
|
|
285
285
|
- Improved TypeScript support: We keep our type definitions for `CMS.init()` and other methods complete, accurate, up-to-date and annotated.[^190][^191][^192][^193][^227] This makes it easier to provide a site config object when [manually initializing](https://decapcms.org/docs/manual-initialization/) the CMS.
|
|
286
|
+
- Sveltia CMS alerts you when there is a mismatch between the `format` and `extension` options of a collection.
|
|
286
287
|
|
|
287
288
|
### Better backend support
|
|
288
289
|
|
|
@@ -303,8 +304,10 @@ The [GitHub](https://decapcms.org/docs/github-backend/), [GitLab](https://decapc
|
|
|
303
304
|
- Comes with background [service status](https://status.gitlab.com/) checking, just like GitHub.
|
|
304
305
|
- Supports Git LFS ([documentation](https://docs.gitlab.com/topics/git/lfs/)).[^231]
|
|
305
306
|
- Users won’t get a 404 Not Found error when you sign in to the GitLab backend.[^115]
|
|
307
|
+
- We have implemented a workaround for a [GraphQL complexity limit issue](https://github.com/sveltia/sveltia-cms/issues/525) in GitLab 18.4.2, while Netlify/Decap CMS continues to suffer from the same problem.[^301]
|
|
306
308
|
- Our Gitea/Forgejo backend is high-performing because it retrieves multiple entries at once. It also supports Git LFS ([documentation](https://docs.gitea.com/administration/git-lfs-setup)). Additionally, the backend won’t cause 400 Bad Request errors due to the presence of `DRAFT_MEDIA_FILES` in file paths.[^222]
|
|
307
309
|
- Features the all-new [local repository workflow](#working-with-a-local-git-repository) for a better DX. See the [productivity section](#better-productivity) above.
|
|
310
|
+
- An indicator is displayed in the account menu when using the local repository workflow.[^302]
|
|
308
311
|
- Developers can select the local and remote backends while working on a local server.
|
|
309
312
|
- 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).
|
|
310
313
|
|
|
@@ -653,13 +656,13 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
|
|
|
653
656
|
|
|
654
657
|
## Compatibility
|
|
655
658
|
|
|
656
|
-
We are working to make Sveltia CMS compatible with Netlify/Decap CMS wherever possible so that more users can seamlessly switch to our modern
|
|
659
|
+
We are working to make Sveltia CMS compatible with Netlify/Decap CMS wherever possible so that more users can seamlessly switch to our modern successor. In some casual use cases, Sveltia CMS can be used as a drop-in replacement for Netlify/Decap CMS with [just a one-line code update](#migration).
|
|
657
660
|
|
|
658
661
|
However, 100% feature parity is never planned, and some features are still missing or will not be added due to performance, deprecation and other factors. Look at the compatibility info below to see if you can migrate now or in the near future.
|
|
659
662
|
|
|
660
663
|
### Current limitations
|
|
661
664
|
|
|
662
|
-
These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
|
|
665
|
+
These Netlify/Decap CMS features are **not yet implemented** in Sveltia CMS. We are working hard to add them before the 1.0 release. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
|
|
663
666
|
|
|
664
667
|
- Comprehensive site config validation
|
|
665
668
|
- Preview for [custom editor components](https://decapcms.org/docs/custom-widgets/#registereditorcomponent) (`CMS.registerEditorComponent`)
|
|
@@ -669,7 +672,7 @@ These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are
|
|
|
669
672
|
|
|
670
673
|
[Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md), [documentation](https://github.com/sveltia/sveltia-cms/issues/485) and a [demo site](https://github.com/sveltia/sveltia-cms/issues/1) will all be prepared once the 1.0 Release Candidate is ready.
|
|
671
674
|
|
|
672
|
-
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.
|
|
675
|
+
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.
|
|
673
676
|
|
|
674
677
|
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
675
678
|
- [Open authoring](https://decapcms.org/docs/open-authoring/)
|
|
@@ -1935,6 +1938,10 @@ Join us on [Discord](https://discord.gg/5hwCGqup5b) or ping us on [Bluesky](http
|
|
|
1935
1938
|
|
|
1936
1939
|
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!
|
|
1937
1940
|
|
|
1941
|
+
<!-- prettier-ignore -->
|
|
1942
|
+
> [!IMPORTANT]
|
|
1943
|
+
> 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.
|
|
1944
|
+
|
|
1938
1945
|
## Contributions
|
|
1939
1946
|
|
|
1940
1947
|
See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/main/CONTRIBUTING.md). Bug reports are highly encouraged.
|
|
@@ -1951,7 +1958,7 @@ Due early 2026
|
|
|
1951
1958
|
|
|
1952
1959
|
- Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
|
|
1953
1960
|
- Tackling some more Netlify/Decap CMS issues:
|
|
1954
|
-
- PKCE for GitHub[^285] — It’s [not yet supported](https://github.com/orgs/community/discussions/15752) by GitHub but is planned for
|
|
1961
|
+
- PKCE for GitHub[^285] — It’s [not yet supported](https://github.com/orgs/community/discussions/15752) by GitHub but is [planned for Q4 2025](https://github.com/github/roadmap/issues/1153)
|
|
1955
1962
|
- Thorough site config validation[^246]
|
|
1956
1963
|
- [Entry pre-validation/normalization](https://github.com/sveltia/sveltia-cms/issues/395)[^248]
|
|
1957
1964
|
- Accessibility audit
|
|
@@ -1971,8 +1978,11 @@ Due mid-2026
|
|
|
1971
1978
|
- Tackling even more Netlify/Decap CMS issues:
|
|
1972
1979
|
- [Manual entry sorting](https://github.com/sveltia/sveltia-cms/issues/214)[^125]
|
|
1973
1980
|
- [Directory navigation in the Asset Library](https://github.com/sveltia/sveltia-cms/issues/420)[^240]
|
|
1981
|
+
- [Asset collections](https://github.com/sveltia/sveltia-cms/issues/301)[^271]
|
|
1974
1982
|
- and a few more from the TBD list below
|
|
1975
1983
|
|
|
1984
|
+
See also the [2.0](https://github.com/sveltia/sveltia-cms/milestone/3) milestone.
|
|
1985
|
+
|
|
1976
1986
|
### v3.0
|
|
1977
1987
|
|
|
1978
1988
|
Due late 2026
|
|
@@ -2003,7 +2013,6 @@ Due late 2026
|
|
|
2003
2013
|
- Autoincrement fields[^286]
|
|
2004
2014
|
- Unique constraints[^287]
|
|
2005
2015
|
- Data integrity checks
|
|
2006
|
-
- [Asset collections](https://github.com/sveltia/sveltia-cms/issues/301)[^271]
|
|
2007
2016
|
- [Automatic asset file renaming with templates](https://github.com/sveltia/sveltia-cms/issues/422)[^241]
|
|
2008
2017
|
- and many more (100+ issues and discussions)
|
|
2009
2018
|
- Enhancements to **Sveltia CMS Additions** (some may be included in v3.0):
|
|
@@ -2662,3 +2671,7 @@ This project would not have been possible without the open source Netlify CMS pr
|
|
|
2662
2671
|
[^299]: Netlify/Decap CMS [#5812](https://github.com/decaporg/decap-cms/issues/5812)
|
|
2663
2672
|
|
|
2664
2673
|
[^300]: Netlify/Decap CMS [#7257](https://github.com/decaporg/decap-cms/issues/7257)
|
|
2674
|
+
|
|
2675
|
+
[^301]: Netlify/Decap CMS [#7627](https://github.com/decaporg/decap-cms/issues/7627)
|
|
2676
|
+
|
|
2677
|
+
[^302]: Netlify/Decap CMS [#3286](https://github.com/decaporg/decap-cms/issues/3286)
|