@sveltia/cms 0.38.4 → 0.39.2
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 +10 -10
- package/dist/sveltia-cms.js +3811 -270
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +3811 -270
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +13 -27
package/README.md
CHANGED
|
@@ -44,7 +44,7 @@ Sveltia CMS is **still in beta**, so please be careful when trying it out.
|
|
|
44
44
|
|
|
45
45
|
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:
|
|
46
46
|
|
|
47
|
-
- Ensuring
|
|
47
|
+
- Ensuring substantial [compatibility with existing versions of Netlify/Decap CMS](#compatibility)
|
|
48
48
|
- Tackling as many [issues reported to Netlify/Decap CMS](https://github.com/decaporg/decap-cms/issues) as possible
|
|
49
49
|
- So far, 115+ of them (or 195+ including duplicates) have been effectively solved in Sveltia CMS
|
|
50
50
|
- Target: 150 issues by GA, 250 in a future release
|
|
@@ -70,15 +70,15 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
70
70
|
|
|
71
71
|
- 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.
|
|
72
72
|
- Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
|
|
73
|
-
- Comes with touch device support. While the UI is not yet optimized for small screens, it should work well with large tablets like iPad Pro or Pixel Tablet. Mobile support
|
|
74
|
-
- 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
|
|
73
|
+
- Comes with touch device support, including larger button controls. While the UI is not yet optimized for small screens, it should work well with large tablets like iPad Pro or Pixel Tablet. Mobile support and other optimizations such as swipe navigation are planned after the 1.0 release.
|
|
74
|
+
- 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 unmatched performance!
|
|
75
75
|
- The screenshots above are worth a thousand words, but read on to learn about many other improvements in detail.
|
|
76
76
|
|
|
77
77
|
### Better performance
|
|
78
78
|
|
|
79
79
|
- 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 that can load static data files while building your website or application.
|
|
80
|
-
- Small footprint: The bundle size is less than
|
|
81
|
-
-
|
|
80
|
+
- Small footprint: The bundle size is less than 450 KB when minified and gzipped, which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.8 MB) and Static CMS (2.6 MB), even though we haven’t implemented some features yet[^57][^64].
|
|
81
|
+
- We have upgraded from Svelte 4 to [Svelte 5 Release Candidate](https://svelte.dev/blog/svelte-5-release-candidate) to further boost performance, including faster rendering, reduced memory usage and even smaller bundle size. A full migration to the _runes_ reactivity API will follow.
|
|
82
82
|
- Sveltia CMS is free of technical debt and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
83
83
|
- 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].
|
|
84
84
|
- 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/).
|
|
@@ -306,7 +306,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
306
306
|
|
|
307
307
|
## Compatibility
|
|
308
308
|
|
|
309
|
-
We are trying to make Sveltia CMS
|
|
309
|
+
We are trying to make Sveltia CMS compatible with Netlify/Decap CMS where possible, so that more users can seamlessly switch to our modern, powerful, high performance alternative. However, some features will be omitted due to deprecations and other factors.
|
|
310
310
|
|
|
311
311
|
### Current limitations
|
|
312
312
|
|
|
@@ -335,7 +335,7 @@ Missing any other features? Let us know by [filing an issue](https://github.com/
|
|
|
335
335
|
|
|
336
336
|
### Features not to be implemented
|
|
337
337
|
|
|
338
|
-
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported**
|
|
338
|
+
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends will not be supported** for performance reasons. We may implement a high-performance Git Gateway alternative in the future. We may also support the other services if/when their APIs improve to allow the CMS to fetch multiple files at once.
|
|
339
339
|
- 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.
|
|
340
340
|
- 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.
|
|
341
341
|
- The deprecated Netlify Large Media service will not be supported. Consider other storage providers.
|
|
@@ -347,7 +347,7 @@ Missing any other features? Let us know by [filing an issue](https://github.com/
|
|
|
347
347
|
|
|
348
348
|
### Before the 1.0 release
|
|
349
349
|
|
|
350
|
-
- [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) migration
|
|
350
|
+
- [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) _runes_ migration
|
|
351
351
|
- Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
|
|
352
352
|
- Localization with the new [Fluent](https://projectfluent.org)-powered sveltia-i18n library
|
|
353
353
|
- Accessibility audit
|
|
@@ -453,7 +453,7 @@ You can use Sveltia CMS with a local Git repository like Netlify/Decap CMS, but
|
|
|
453
453
|
- You can remove `local_backend` from your configuration, as it will be ignored by Sveltia CMS.
|
|
454
454
|
1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
|
|
455
455
|
1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
|
|
456
|
-
- Other Chromium-based browsers may also work. Brave user? [See below](#
|
|
456
|
+
- Other Chromium-based browsers may also work. Brave user? [See below](#enabling-local-development-in-brave).
|
|
457
457
|
1. Click “Work with Local Repository” and select the project’s root directory once prompted.
|
|
458
458
|
- If you get an error saying “not a repository root directory”, make sure you’ve turned the folder into a repository with either a CUI ([`git init`](https://github.com/git-guides/git-init)) or GUI, and the hidden `.git` folder exists.
|
|
459
459
|
- If you’re using Windows Subsystem for Linux (WSL), you may get an error saying “Can’t open this folder because it contains system files.” This is due to a limitation in the browser, and you can try some workarounds mentioned in [this issue](https://github.com/coder/code-server/issues/4646) and [this thread](https://github.com/sveltia/sveltia-cms/discussions/101).
|
|
@@ -466,7 +466,7 @@ Keep in mind that the local repository support doesn’t perform any Git operati
|
|
|
466
466
|
|
|
467
467
|
Also, at this point, you have to reload the CMS to see the latest content after retrieving remote updates. This manual work will be unnecessary once the proposed `FileSystemObserver` API, which is being [implemented in Chromium](https://issues.chromium.org/issues/40105284) behind a flag, becomes available.
|
|
468
468
|
|
|
469
|
-
|
|
469
|
+
### Enabling local development in Brave
|
|
470
470
|
|
|
471
471
|
In the Brave browser, you must enable the File System Access API with an experiment flag to take advantage of local development.
|
|
472
472
|
|