@sveltia/cms 0.41.1 → 0.42.0

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # Sveltia CMS
2
2
 
3
- Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and Decap CMS. In some simple cases, migration is as easy as a single line of code change, although we are still working on improving compatibility. The free, open source alternative to Netlify/Decap CMS is now in public beta, offering a slew of improvements in UX, performance, i18n support and more.
3
+ Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and Decap CMS. In some simple cases, migration is as easy as a single line of code change, although we are still working on improving compatibility. The free, open source alternative to Netlify/Decap CMS is now in public beta, offering great UX, performance, i18n support and more.
4
4
 
5
5
  ![Screenshot: Open Source Git-based Headless CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/screenshot-1-20240507.webp)<br>
6
6
 
@@ -79,16 +79,14 @@ To achieve radical improvements in UX, performance, i18n and other areas, it was
79
79
 
80
80
  Due to its unfortunate abandonment, Netlify CMS spawned 3 successors:
81
81
 
82
- - [Static CMS](https://github.com/StaticJsCMS/static-cms): a community maintenance fork, initial commit made in September 2022, discontinued in September 2024
82
+ - [Static CMS](https://github.com/StaticJsCMS/static-cms): a community fork, initial commit made in September 2022, discontinued in September 2024
83
83
  - **Sveltia CMS**: a total reboot, started in November 2022, first appeared on GitHub in March 2023
84
- - [Decap CMS](https://github.com/decaporg/decap-cms): a rebranded version, owned by a Netlify agency partner, [announced in February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/) as the official successor
84
+ - [Decap CMS](https://github.com/decaporg/decap-cms): a rebranded version, [announced in February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/) as the official successor, with a Netlify agency partner taking ownership
85
85
 
86
86
  Sveltia CMS is the only project that doesn’t inherit the complexity, technical debt and miscellaneous bugs of Netlify CMS, which was launched back in 2015. We are confident that our decision to rebuild the application from scratch was the right one, as proven by the [hundreds of improvements](#differentiators) we have already made.
87
87
 
88
88
  While Sveltia CMS is specifically designed to replace legacy Netlify CMS instances, it also aims to serve as a substitute for the other products.
89
89
 
90
- Note: While we are closely following the development of Decap CMS, compatibility with Static CMS will be worked on mostly after the release of Sveltia CMS 1.0.
91
-
92
90
  ### Our goals
93
91
 
94
92
  - Making Sveltia CMS a viable, definitive successor to Netlify CMS
@@ -101,7 +99,7 @@ Note: While we are closely following the development of Decap CMS, compatibility
101
99
 
102
100
  Sveltia CMS is currently in **beta**, and version 1.0 is expected to ship in **early 2025**, with a release candidate hopefully by the end of 2024. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) for updates. See also our [roadmap](#roadmap).
103
101
 
104
- 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:
102
+ 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:
105
103
 
106
104
  - Ensuring substantial [compatibility with Netlify/Decap CMS](#compatibility)
107
105
  - Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
@@ -420,7 +418,7 @@ These limitations are expected to be resolved before or shortly after GA:
420
418
  | Workflow | Editorial Workflow and Open Authoring are not yet supported and will be implemented after the 1.0 release. |
421
419
  | Collections | Nested Collections are not yet supported and will be implemented after the 1.0 release. |
422
420
  | Widgets | Custom widgets are not yet supported. See the table below for other limitations. |
423
- | Customizations | Custom previews, custom formatters and event subscriptions are not yet supported. |
421
+ | Customizations | Custom previews and event subscriptions are not yet supported. |
424
422
 
425
423
  | Widget | Status in Sveltia CMS |
426
424
  | --- | --- |
@@ -430,6 +428,8 @@ These limitations are expected to be resolved before or shortly after GA:
430
428
  | Map | Not yet supported. |
431
429
  | Markdown | Editor components, including built-in `image` and `code-block` as well as custom components, are not yet supported. |
432
430
 
431
+ We also plan to provide partial compatibility with new features added to Static CMS, such as the [KeyValue widget](https://staticjscms.netlify.app/docs/widget-keyvalue).
432
+
433
433
  Found a compatibility issue or other missing feature? Let us know by [filing an issue](https://github.com/sveltia/sveltia-cms/issues/new).
434
434
 
435
435
  ## Getting started
@@ -479,6 +479,8 @@ That said, we strongly recommend testing your new Sveltia CMS instance first on
479
479
 
480
480
  Sveltia CMS does not support the Git Gateway backend due to performance limitations. If you don’t care about user management with Netlify Identity, you can use the [GitHub backend](https://decapcms.org/docs/github-backend/) or [GitLab backend](https://decapcms.org/docs/gitlab-backend/) instead. Make sure **you install an OAuth client** on GitHub or GitLab in addition to updating your configuration file. As noted in the document, Netlify is still able to facilitate the auth flow.
481
481
 
482
+ To allow multiple users to edit content, simply invite people to your GitHub repository with the write role assigned.
483
+
482
484
  Once you have migrated from the Git Gateway and Netlify Identity combo, you can remove the Netlify Identity widget script tag from your HTML:
483
485
 
484
486
  ```diff