@sveltia/cms 0.72.2 → 0.72.4
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 -9
- package/dist/sveltia-cms.js +112 -112
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +131 -131
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -147,7 +147,7 @@ Netlify/Decap CMS users will definitely be pleased and surprised by the numerous
|
|
|
147
147
|
### Better UX
|
|
148
148
|
|
|
149
149
|
- Created and actively 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.
|
|
150
|
-
- The maintainer tries to
|
|
150
|
+
- The maintainer tries to respond to bug reports as quickly as possible. While there are no guarantees, the typical turnaround time for a bug fix is less than 24 hours.
|
|
151
151
|
- Frequent releases deliver new features and enhancements to users faster. Most of our minor [releases](https://github.com/sveltia/sveltia-cms/releases) address one or more Netlify/Decap CMS issues, giving you even more reasons to switch from the legacy predecessor.
|
|
152
152
|
- Offers a modern, intuitive user interface that utilizes the full viewport,[^178] inspired in part by the Netlify CMS v3 prototype.[^1]
|
|
153
153
|
- Provides immersive dark mode.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
|
|
@@ -522,7 +522,7 @@ However, 100% feature parity is not planned, and some features are still missing
|
|
|
522
522
|
|
|
523
523
|
### Features not to be implemented
|
|
524
524
|
|
|
525
|
-
- **Azure, Bitbucket and Forgejo backends**: For performance reasons. We may support these platforms if their APIs improve to allow the CMS to fetch multiple entries at once. The Gitea backend [may be implemented](https://github.com/sveltia/sveltia-cms/issues/198), but it won’t be compatible with Forgejo due to API differences.
|
|
525
|
+
- **Azure, Bitbucket and Forgejo backends**: For performance reasons. We may support these platforms if their APIs improve to allow the CMS to fetch multiple entries at once. The Gitea backend [may be implemented](https://github.com/sveltia/sveltia-cms/issues/198), but it won’t be [compatible with Forgejo](https://github.com/sveltia/sveltia-cms/issues/381) due to API differences.
|
|
526
526
|
- **Git Gateway backend**: Also for performance reasons. [Git Gateway](https://github.com/netlify/git-gateway) has not been actively maintained since Netlify CMS was abandoned, and it’s known to be slow and prone to rate limit violations. We plan to develop a GraphQL-based high-performance alternative in the future.
|
|
527
527
|
- **Netlify Identity Widget**: It’s not useful without Git Gateway, and the Netlify Identity service itself is now [deprecated](https://www.netlify.com/changelog/deprecation-netlify-identity/). We plan to develop an alternative solution with role support in the future, most likely using [Cloudflare Workers](https://workers.cloudflare.com/) and [Auth.js](https://authjs.dev/).
|
|
528
528
|
- The deprecated client-side implicit grant for the GitLab backend: It has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
@@ -562,7 +562,7 @@ These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are
|
|
|
562
562
|
- [Custom previews](https://decapcms.org/docs/customization/) ([#51](https://github.com/sveltia/sveltia-cms/issues/51))
|
|
563
563
|
- [Event hooks](https://decapcms.org/docs/registering-events/) ([#167](https://github.com/sveltia/sveltia-cms/issues/167))
|
|
564
564
|
|
|
565
|
-
Due to the complexity, the following features
|
|
565
|
+
Due to the complexity, we have decided to defer the following features to the 2.0 release. Netlify/Decap CMS has a number of open issues with the collaboration and beta features — we want to implement them the right way.
|
|
566
566
|
|
|
567
567
|
- [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
568
568
|
- [Open Authoring](https://decapcms.org/docs/open-authoring/)
|
|
@@ -593,11 +593,11 @@ Sveltia CMS provides partial compatibility with [Static CMS](https://github.com/
|
|
|
593
593
|
|
|
594
594
|
### Framework support
|
|
595
595
|
|
|
596
|
-
While Sveltia CMS is built with Svelte, the application is **framework-agnostic
|
|
596
|
+
While Sveltia CMS is built with Svelte, the application is **framework-agnostic**. It’s a small, compiled, vanilla JavaScript bundle that manages content in a Git repository directly via the REST/GraphQL API. It doesn’t interact with the framework that builds your site.
|
|
597
597
|
|
|
598
|
-
|
|
598
|
+
So you can use the CMS with any framework or static site generator (SSG) that can load static files during the build process, including but not limited to Astro, Eleventy, Hugo, Jekyll, Next.js, SvelteKit and VitePress.
|
|
599
599
|
|
|
600
|
-
We have added support for features
|
|
600
|
+
We have added support for features used by certain frameworks and i18n libraries, such as [index file inclusion](#including-hugos-special-index-file-in-a-folder-collection) and [slug localization](#localizing-entry-slugs) for Hugo, as well as [some enhancements](https://github.com/sveltia/sveltia-cms/issues/230) for VitePress. [Let us know](https://github.com/sveltia/sveltia-cms/issues/new?type=feature) if your framework has specific needs.
|
|
601
601
|
|
|
602
602
|
### Browser support
|
|
603
603
|
|
|
@@ -635,7 +635,9 @@ Unfortunately, we are unable to provide free installation and setup support at t
|
|
|
635
635
|
|
|
636
636
|
### Migration
|
|
637
637
|
|
|
638
|
-
Have a look at the [compatibility info](#compatibility) above first. If you’re already using Netlify/Decap CMS with the GitHub or GitLab backend and don’t have any unsupported features like custom widgets or nested collections, migrating to Sveltia CMS is super easy — it works as a drop-in replacement.
|
|
638
|
+
Have a look at the [compatibility info](#compatibility) above first. If you’re already using Netlify/Decap CMS with the GitHub or GitLab backend and don’t have any unsupported features like custom widgets or nested collections, migrating to Sveltia CMS is super easy — it works as a drop-in replacement.
|
|
639
|
+
|
|
640
|
+
Open `/admin/index.html` locally with an editor like VS Code and replace the CMS `<script>` tag with the new one:
|
|
639
641
|
|
|
640
642
|
```html
|
|
641
643
|
<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js"></script>
|
|
@@ -655,9 +657,9 @@ From Decap CMS:
|
|
|
655
657
|
+<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js"></script>
|
|
656
658
|
```
|
|
657
659
|
|
|
658
|
-
|
|
660
|
+
Next, let’s [test Sveltia CMS on your local machine](#working-with-a-local-git-repository). If everything looks good, push the change to your repository.
|
|
659
661
|
|
|
660
|
-
|
|
662
|
+
You can now open `https://[hostname]/admin/` as usual to start editing. There is even no authentication process if you’re already signed in with GitHub or GitLab on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
|
|
661
663
|
|
|
662
664
|
#### Migrating from Git Gateway backend
|
|
663
665
|
|