@sveltia/cms 0.40.1 → 0.40.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 +11 -4
- package/dist/sveltia-cms.js +180 -182
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +231 -233
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -103,6 +103,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
103
103
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
104
104
|
- So far, 120+ of them (or 215+ including duplicates) have been effectively solved in Sveltia CMS
|
|
105
105
|
- Target: 150 issues by GA, 250 (or all the relevant and fixable issues) in a future release
|
|
106
|
+
- Note: issues include both feature requests and bug reports
|
|
106
107
|
- [Let us know](https://github.com/sveltia/sveltia-cms/issues/new) if you have any specific issues you’d like to see solved!
|
|
107
108
|
- Responding to feedback from clients and regular users
|
|
108
109
|
- Implementing our own enhancement ideas for every part of the product
|
|
@@ -118,6 +119,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
118
119
|
### Better UX
|
|
119
120
|
|
|
120
121
|
- 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.
|
|
122
|
+
- The maintainer tries to be as responsive as possible. Reported bugs are usually fixed within 24 hours.
|
|
121
123
|
- Offers a modern, intuitive user interface, including an immersive dark mode[^2], inspired in part by the Netlify CMS v3 prototype[^1].
|
|
122
124
|
- Comes with touch device support, such as larger buttons for easier tapping. 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.
|
|
123
125
|
- 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][^129]. Best of all, Svelte offers unmatched performance!
|
|
@@ -133,8 +135,8 @@ We are working hard to create a **significantly better alternative to Netlify CM
|
|
|
133
135
|
- Sveltia CMS is free of technical debt and [virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
134
136
|
- 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].
|
|
135
137
|
- 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/).
|
|
136
|
-
- Using caching and lazy loading techniques. A list of repository files is stored locally for faster startup and bandwidth savings.
|
|
137
138
|
- Sorting, filtering and grouping of entries is done instantly without reloading the entire content.
|
|
139
|
+
- Using caching and lazy loading techniques. A list of repository files is stored locally for faster startup and bandwidth savings.
|
|
138
140
|
- 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].
|
|
139
141
|
- No typing lag on input widgets, especially within nested lists and objects[^77].
|
|
140
142
|
|
|
@@ -365,11 +367,13 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
365
367
|
|
|
366
368
|
## Compatibility
|
|
367
369
|
|
|
368
|
-
We are trying to make Sveltia CMS compatible with Netlify/Decap CMS where possible, so that more users can seamlessly switch to our modern
|
|
370
|
+
We are trying to make Sveltia CMS compatible with Netlify/Decap CMS where possible, so that more users can seamlessly switch to our modern alternative. It’s ready to be used as a drop-in replacement for Netlify/Decap CMS in some casual use case scenarios with a [single line of code update](#migration).
|
|
371
|
+
|
|
372
|
+
However, some features are still missing or will not be added due to deprecation and other factors. Look at the compatibility info below to see if you can migrate now or soon.
|
|
369
373
|
|
|
370
374
|
### Features not to be implemented
|
|
371
375
|
|
|
372
|
-
- **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
|
|
376
|
+
- **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 platforms if/when their APIs improve to allow the CMS to fetch multiple files at once.
|
|
373
377
|
- **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.
|
|
374
378
|
- 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.
|
|
375
379
|
- The deprecated Netlify Large Media service will not be supported. Consider other storage providers.
|
|
@@ -400,7 +404,7 @@ These limitations are expected to be resolved before or shortly after GA:
|
|
|
400
404
|
| Map | Not yet supported. |
|
|
401
405
|
| Markdown | Editor components, including built-in `image` and `code-block` as well as custom components, are not yet supported. |
|
|
402
406
|
|
|
403
|
-
|
|
407
|
+
Found a compatibility issue or other missing feature? Let us know by [filing an issue](https://github.com/sveltia/sveltia-cms/issues/new).
|
|
404
408
|
|
|
405
409
|
## Getting started
|
|
406
410
|
|
|
@@ -489,12 +493,15 @@ If you get an “Authentication Aborted” error when trying to sign in to GitHu
|
|
|
489
493
|
|
|
490
494
|
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).
|
|
491
495
|
|
|
496
|
+
Basically there are only two differences: you don’t need to run the proxy server, and you need to select your project folder in the browser instead. Here are the detailed steps:
|
|
497
|
+
|
|
492
498
|
1. Make sure you have configured the [GitHub](https://decapcms.org/docs/github-backend/) or [GitLab](https://decapcms.org/docs/gitlab-backend/) backend.
|
|
493
499
|
- 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.
|
|
494
500
|
- You can remove `local_backend` from your configuration, as it will be ignored by Sveltia CMS.
|
|
495
501
|
1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
|
|
496
502
|
1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
|
|
497
503
|
- Other Chromium-based browsers may also work. Brave user? [See below](#enabling-local-development-in-brave).
|
|
504
|
+
- The `127.0.0.1` address can also be used instead of `localhost`.
|
|
498
505
|
1. Click “Work with Local Repository” and select the project’s root directory once prompted.
|
|
499
506
|
- 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.
|
|
500
507
|
- 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).
|