@sveltia/cms 0.40.0 → 0.40.1

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
@@ -36,18 +36,15 @@ Sveltia CMS is a Git-based lightweight headless CMS under active development as
36
36
  - [Compatibility](#compatibility)
37
37
  - [Features not to be implemented](#features-not-to-be-implemented)
38
38
  - [Current limitations](#current-limitations)
39
- - [Roadmap](#roadmap)
40
- - [Before the 1.0 release](#before-the-10-release)
41
- - [After the 1.0 release](#after-the-10-release)
42
39
  - [Getting started](#getting-started)
43
40
  - [New users](#new-users)
44
41
  - [Migration](#migration)
42
+ - [Migrating from Git Gateway backend](#migrating-from-git-gateway-backend)
43
+ - [Moving your site from Netlify to another hosting service](#moving-your-site-from-netlify-to-another-hosting-service)
45
44
  - [Installing with npm](#installing-with-npm)
46
45
  - [Updates](#updates)
47
46
  - [Tips \& tricks](#tips--tricks)
48
47
  - [Providing a JSON configuration file](#providing-a-json-configuration-file)
49
- - [Migrating from Git Gateway backend](#migrating-from-git-gateway-backend)
50
- - [Moving your site from Netlify to another hosting service](#moving-your-site-from-netlify-to-another-hosting-service)
51
48
  - [Working around authentication error](#working-around-authentication-error)
52
49
  - [Working with a local Git repository](#working-with-a-local-git-repository)
53
50
  - [Enabling local development in Brave](#enabling-local-development-in-brave)
@@ -63,6 +60,9 @@ Sveltia CMS is a Git-based lightweight headless CMS under active development as
63
60
  - [Setting up Content Security Policy](#setting-up-content-security-policy)
64
61
  - [Support \& feedback](#support--feedback)
65
62
  - [Contributions](#contributions)
63
+ - [Roadmap](#roadmap)
64
+ - [Before the 1.0 release](#before-the-10-release)
65
+ - [After the 1.0 release](#after-the-10-release)
66
66
  - [Related links](#related-links)
67
67
  - [As seen on](#as-seen-on)
68
68
  - [Disclaimer](#disclaimer)
@@ -124,7 +124,6 @@ We are working hard to create a **significantly better alternative to Netlify CM
124
124
  - The Help menu provides all links to useful resources, including release notes, feedback and support.
125
125
  - Users can customize the application with various settings.
126
126
  - Never miss out on the latest features and bug fixes by being notified when an update to the CMS is available[^31]. Then update to the latest version with a single click[^66].
127
- - The screenshots above are worth a thousand words, but read on to learn about many other improvements in detail.
128
127
 
129
128
  ### Better performance
130
129
 
@@ -149,6 +148,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
149
148
  - A local backup of an entry draft is automatically created without interruption by a confirmation dialog, which annoys users and can cause a page navigation problem if dismissed[^106]. The backup can then be reliably restored without unexpected overwriting[^85].
150
149
  - Click once (the Save button) instead of twice (Publish > Publish now) to save an entry.
151
150
  - The editor closes automatically when an entry is saved. This behaviour can be changed in Settings.
151
+ - Uploading files can be done with drag and drop[^20].
152
152
  - You can upload multiple assets at once[^5].
153
153
  - You can delete multiple entries and assets at once.
154
154
  - Some [keyboard shortcuts](#using-keyboard-shortcuts) are available for faster editing.
@@ -161,7 +161,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
161
161
  - Ensures sufficient contrast between the foreground text and background colours.
162
162
  - Enabled and disabled buttons can be clearly distinguished[^105].
163
163
  - Links are underlined by default to make them easier to recognize. This behaviour can be changed in the Accessibility Settings if you prefer.
164
- - 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.)
164
+ - 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.
165
165
  - Browser console logs for developers are readable in either light or dark mode[^116].
166
166
  - We’ll continue to test and improve the application to meet [WCAG 2.2](https://w3c.github.io/wcag/guidelines/22/).
167
167
 
@@ -344,7 +344,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
344
344
 
345
345
  ### Better asset management
346
346
 
347
- - A completely new Asset Library, built separately from the image selection dialog, makes it easy to manage all of your files, including images, videos and documents[^96].
347
+ - A completely new, full-fledged Asset Library, built separately from the image selection dialog, makes it easy to manage all of your files, including images, videos and documents[^96].
348
348
  - Navigate between the global media folder and per-collection media folders[^6].
349
349
  - Preview image, audio, video, text and PDF files. Check your site’s [CSP](#setting-up-content-security-policy) if the preview doesn’t work.
350
350
  - Copy the public URL[^74], file path, text data or image data of a selected asset to clipboard. The file path starts with `/` as expected[^48].
@@ -402,31 +402,6 @@ These limitations are expected to be resolved before or shortly after GA:
402
402
 
403
403
  Missing any other features? Let us know by [filing an issue](https://github.com/sveltia/sveltia-cms/issues/new).
404
404
 
405
- ## Roadmap
406
-
407
- ### Before the 1.0 release
408
-
409
- - [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) _runes_ migration
410
- - Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
411
- - Certain compatibility with Static CMS, a now-discontinued community fork of Netlify CMS, specifically the [KeyValue widget](https://staticjscms.netlify.app/docs/widget-keyvalue)[^123]
412
- - Localization with the new [Fluent](https://projectfluent.org)-powered sveltia-i18n library
413
- - Accessibility audit
414
- - Developer documentation (implementation guide)
415
- - Marketing site
416
- - Live demo site
417
- - Official starter templates for the most popular frameworks, including SvelteKit and Next.js
418
- - Broad automation test coverage (Vitest + Playwright)
419
-
420
- ### After the 1.0 release
421
-
422
- - Tackling more Netlify/Decap CMS issues, especially the [top voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including MDX support[^122], manual entry sorting[^125], roles[^23], mobile optimization[^18] and config editor[^10] — Some features are already implemented in Sveltia CMS
423
- - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
424
- - AI integrations for image generation and content writing
425
- - End-user documentation
426
- - Contributor documentation
427
- - Marketplace for custom widgets, etc.
428
- - and so much more!
429
-
430
405
  ## Getting started
431
406
 
432
407
  ### New users
@@ -470,6 +445,20 @@ That’s it! You can open `https://[hostname]/admin/` as before to start editing
470
445
 
471
446
  That said, we strongly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#working-with-a-local-git-repository) for how.
472
447
 
448
+ #### Migrating from Git Gateway backend
449
+
450
+ 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.
451
+
452
+ Once you have migrated from the Git Gateway and Netlify Identity combo, you can remove the Netlify Identity widget script tag from your HTML:
453
+
454
+ ```diff
455
+ -<script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>
456
+ ```
457
+
458
+ #### Moving your site from Netlify to another hosting service
459
+
460
+ You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com/). But moving away from Netlify means you can no longer sign in with GitHub or GitLab via Netlify. Instead, you can use [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth), which can be easily deployed to Cloudflare Workers, or [any other 3rd party client](https://decapcms.org/docs/external-oauth-clients/) made for Netlify/Decap CMS.
461
+
473
462
  ### Installing with npm
474
463
 
475
464
  For advanced users, we have also made the bundle available as an [npm package](https://www.npmjs.com/package/@sveltia/cms). You can install it by running `npm i @sveltia/cms` or `pnpm add @sveltia/cms` on your project. The [manual initialization](https://decapcms.org/docs/manual-initialization/) flow with the `init` method is the same as for Netlify/Decap CMS.
@@ -492,20 +481,6 @@ Sveltia CMS supports a configuration file written in the JSON format in addition
492
481
 
493
482
  Alternatively, you can [manually initialize](https://decapcms.org/docs/manual-initialization/) the CMS with a JavaScript configuration object.
494
483
 
495
- ### Migrating from Git Gateway backend
496
-
497
- 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.
498
-
499
- Once you have migrated from the Git Gateway and Netlify Identity combo, you can remove the Netlify Identity widget script tag from your HTML:
500
-
501
- ```diff
502
- -<script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>
503
- ```
504
-
505
- ### Moving your site from Netlify to another hosting service
506
-
507
- You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com/). But moving away from Netlify means you can no longer sign in with GitHub or GitLab via Netlify. Instead, you can use [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth), which can be easily deployed to Cloudflare Workers, or [any other 3rd party client](https://decapcms.org/docs/external-oauth-clients/) made for Netlify/Decap CMS.
508
-
509
484
  ### Working around authentication error
510
485
 
511
486
  If you get an “Authentication Aborted” error when trying to sign in to GitHub or GitLab using the authorization code flow, you may need to check your site’s [`Cross-Origin-Opener-Policy`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cross-Origin-Opener-Policy). The COOP header is not widely used, but it’s known to break the OAuth flow with a popup window. If that’s your case, changing `same-origin` to `same-origin-allow-popups` solves the problem. ([Discussion](https://github.com/sveltia/sveltia-cms/issues/131))
@@ -857,6 +832,31 @@ Looking to build a website with Sveltia CMS? Maintainer [@kyoshino](https://gith
857
832
 
858
833
  See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/main/CONTRIBUTING.md).
859
834
 
835
+ ## Roadmap
836
+
837
+ ### Before the 1.0 release
838
+
839
+ - [Svelte 5](https://svelte.dev/blog/svelte-5-release-candidate) _runes_ migration
840
+ - Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
841
+ - Certain compatibility with Static CMS, a now-discontinued community fork of Netlify CMS, specifically the [KeyValue widget](https://staticjscms.netlify.app/docs/widget-keyvalue)[^123]
842
+ - Localization with the new [Fluent](https://projectfluent.org)-powered sveltia-i18n library
843
+ - Accessibility audit
844
+ - Developer documentation (implementation guide)
845
+ - Marketing site
846
+ - Live demo site
847
+ - Official starter templates for the most popular frameworks, including SvelteKit and Next.js
848
+ - Broad automation test coverage (Vitest + Playwright)
849
+
850
+ ### After the 1.0 release
851
+
852
+ - Tackling more Netlify/Decap CMS issues, especially the [top voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc), including MDX support[^122], manual entry sorting[^125], roles[^23], mobile optimization[^18] and config editor[^10] — Some features are already implemented in Sveltia CMS
853
+ - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
854
+ - AI integrations for image generation and content writing
855
+ - End-user documentation
856
+ - Contributor documentation
857
+ - Marketplace for custom widgets, etc.
858
+ - and so much more!
859
+
860
860
  ## Related links
861
861
 
862
862
  - Introducing Sveltia CMS: a short technical presentation by [@kyoshino](https://github.com/kyoshino) during the _This Week in Svelte_ online meetup on March 31, 2023 — [recording](https://youtu.be/-YjLubiieYs?t=1660) & [slides](https://docs.google.com/presentation/d/1Wi4ty-1AwOp2-zy7LctmzCV4rrdYPfke9NGhO0DdRdM)