@sveltia/cms 0.36.3 → 0.36.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 +14 -12
- package/dist/sveltia-cms.js +149 -149
- package/dist/sveltia-cms.mjs +147 -147
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ Due to its unfortunate abandonment, Netlify CMS spawned 3 successors:
|
|
|
28
28
|
|
|
29
29
|
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 2016. We are confident that our decision to rebuild the application from scratch was the right one, as proven by the hundreds of improvements we have already made.
|
|
30
30
|
|
|
31
|
-
While Sveltia CMS is specifically designed to replace legacy Netlify CMS instances, it also aims to serve as a substitute for the other products
|
|
31
|
+
While Sveltia CMS is specifically designed to replace legacy Netlify CMS instances, it also aims to serve as a substitute for the other products. (Note: Static CMS compatibility will be worked on after the Sveltia CMS 1.0 release)
|
|
32
32
|
|
|
33
33
|
### Our goals
|
|
34
34
|
|
|
@@ -72,7 +72,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
72
72
|
- 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.
|
|
73
73
|
- Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
|
|
74
74
|
- Comes with touch device support. While the UI is not yet optimized for small screens, large tablets like iPad Pro or Pixel Tablet should work well. Mobile support is planned after the 1.0 release.
|
|
75
|
-
- Made with Svelte, not React, means we can spend more time on UX rather than tedious state management. It also allows us to avoid fatal
|
|
75
|
+
- Made with Svelte, not React, means we can spend more time on UX rather than tedious state management. It also allows us to avoid common fatal application crashes[^113]. Best of all, Svelte offers great performance!
|
|
76
76
|
- The screenshots above are worth a thousand words, but read on to learn about many other improvements in detail.
|
|
77
77
|
|
|
78
78
|
### Better performance
|
|
@@ -84,7 +84,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
84
84
|
- 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]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
|
|
85
85
|
- 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/).
|
|
86
86
|
- Using caching and lazy loading techniques. A list of repository files is stored locally for faster startup and bandwidth savings.
|
|
87
|
-
- Thumbnails of assets, including PDF files, are generated and cached for faster rendering of the Asset Library and other parts of the CMS[^39].
|
|
87
|
+
- Thumbnails of assets, including videos and PDF files, are generated and cached for faster rendering of the Asset Library and other parts of the CMS[^39].
|
|
88
88
|
- No typing lag on input widgets, especially within nested lists and objects[^77].
|
|
89
89
|
|
|
90
90
|
### Better productivity
|
|
@@ -110,6 +110,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
110
110
|
- Enabled and disabled buttons can be clearly distinguished[^105].
|
|
111
111
|
- Links are underlined by default to make them easier to recognize. This behaviour can be changed in the Accessibility Settings if you prefer.
|
|
112
112
|
- Honours your operating system’s [reduced motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) and [reduced transparency](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-transparency) settings. (Support for [high contrast mode](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) will be added later.)
|
|
113
|
+
- Browser console logs for developers are readable in either light or dark mode[^116].
|
|
113
114
|
- We’ll continue to test and improve the application to meet [WCAG 2.2](https://w3c.github.io/wcag/guidelines/22/).
|
|
114
115
|
|
|
115
116
|
### Better security
|
|
@@ -155,6 +156,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
155
156
|
- You can easily switch between locales while editing by clicking a button instead of a dropdown list. No internal error is thrown when changing the locale[^103].
|
|
156
157
|
- Language labels appear in human-readable display names instead of ISO 639 language codes, which not everyone is familiar with. (For example, it might be difficult to recognize `DE` as German, `NL` as Dutch, or `ZH` as Chinese.)
|
|
157
158
|
- The List widget’s `label` and `label_singular` are not converted to lowercase, which is especially problematic in German, where all nouns are capitalized[^98].
|
|
159
|
+
- Long menu item labels, especially in non-English locales, don’t overflow the dropdown container[^117].
|
|
158
160
|
- Content editing
|
|
159
161
|
- [Integrates DeepL](#using-deepl-to-translate-entry-fields) to allow translation of text fields from another locale with one click. More translation services will be added in the future.
|
|
160
162
|
- You can [disable non-default locale content](#disabling-non-default-locale-content)[^15].
|
|
@@ -300,7 +302,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
300
302
|
|
|
301
303
|
## Compatibility
|
|
302
304
|
|
|
303
|
-
We are trying to make Sveltia CMS as compatible as possible with Netlify/Decap CMS, so that more users can seamlessly switch to our modern, powerful alternative. However, some features will be omitted due to deprecations and other factors.
|
|
305
|
+
We are trying to make Sveltia CMS as compatible as possible with Netlify/Decap CMS, so that more users can seamlessly switch to our modern, powerful, performant alternative. However, some features will be omitted due to deprecations and other factors.
|
|
304
306
|
|
|
305
307
|
### Current limitations
|
|
306
308
|
|
|
@@ -329,7 +331,7 @@ Missing any other features? Let us know by [filing an issue](https://github.com/
|
|
|
329
331
|
|
|
330
332
|
### Features not to be implemented
|
|
331
333
|
|
|
332
|
-
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported** due to performance limitations. We may implement a
|
|
334
|
+
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported** due to performance limitations. We may implement a high-performance Git Gateway alternative in the future.
|
|
333
335
|
- The Netlify Identity Widget will not be supported, as it’s not useful without Git Gateway. We may be able to support it in the future if/when a Git Gateway alternative is created.
|
|
334
336
|
- The deprecated client-side implicit grant for the GitLab backend will not be supported, as it has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
335
337
|
- The deprecated Netlify Large Media service will not be supported. Consider other storage providers.
|
|
@@ -443,7 +445,7 @@ If you get an “Authentication Aborted” error when trying to sign in to GitHu
|
|
|
443
445
|
You can use Sveltia CMS with a local Git repository like Netlify/Decap CMS, but Sveltia CMS has simplified the workflow by removing the need for additional configuration (the `local_backend` property) and a proxy server, thanks to the [File System Access API](https://developer.chrome.com/articles/file-system-access/) available in [some modern browsers](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility).
|
|
444
446
|
|
|
445
447
|
1. Make sure you have configured the [GitHub](https://decapcms.org/docs/github-backend/) or [GitLab](https://decapcms.org/docs/gitlab-backend/) backend.
|
|
446
|
-
- Please note that the Git Gateway backend mentioned in the Netlify/Decap CMS [local Git repository document](https://decapcms.org/docs/working-with-a-local-git-repository/) is not supported in Sveltia CMS, so `name: git-gateway` won’t work. You’ll need either `name: github` or `name: gitlab` along with the `repo` definition.
|
|
448
|
+
- Please note that the Git Gateway backend mentioned in the Netlify/Decap CMS [local Git repository document](https://decapcms.org/docs/working-with-a-local-git-repository/) is not supported in Sveltia CMS, so `name: git-gateway` won’t work. You’ll need either `name: github` or `name: gitlab` along with the `repo` definition. If you haven’t determined your repository name yet, just use a random one.
|
|
447
449
|
- You can remove `local_backend` from your configuration, as it will be ignored by Sveltia CMS.
|
|
448
450
|
1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
|
|
449
451
|
1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
|
|
@@ -767,17 +769,13 @@ img-src 'self' blob: data: https://*;
|
|
|
767
769
|
|
|
768
770
|
## Support & feedback
|
|
769
771
|
|
|
770
|
-
|
|
772
|
+
While we don’t have dedicated developer/user support resources, quick questions and feedback are welcome on the [Discussions](https://github.com/sveltia/sveltia-cms/discussions) page of this GitHub repository.
|
|
771
773
|
|
|
772
774
|
Looking to build a website with Sveltia CMS? Maintainer [@kyoshino](https://github.com/kyoshino) is available for hire depending on your requirements. Feel free to reach out!
|
|
773
775
|
|
|
774
776
|
## Contributions
|
|
775
777
|
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
Tips are always welcome! The project hasn’t set up a sponsorship program, but maintainer [@kyoshino](https://github.com/kyoshino) has a [PayPal account](https://paypal.me/kohei).
|
|
779
|
-
|
|
780
|
-
Last but not least, don’t forget to star this project and spread the word so more users can benefit from a better CMS experience!
|
|
778
|
+
See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/main/CONTRIBUTING.md).
|
|
781
779
|
|
|
782
780
|
## Related links
|
|
783
781
|
|
|
@@ -1021,3 +1019,7 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
1021
1019
|
[^114]: Netlify/Decap CMS [#5029](https://github.com/decaporg/decap-cms/issues/5029), [#5048](https://github.com/decaporg/decap-cms/issues/5048)
|
|
1022
1020
|
|
|
1023
1021
|
[^115]: Netlify/Decap CMS [#7172](https://github.com/decaporg/decap-cms/issues/7172)
|
|
1022
|
+
|
|
1023
|
+
[^116]: Netlify/Decap CMS [#3431](https://github.com/decaporg/decap-cms/issues/3431)
|
|
1024
|
+
|
|
1025
|
+
[^117]: Netlify/Decap CMS [#3562](https://github.com/decaporg/decap-cms/issues/3562)
|