@sveltia/cms 0.40.4 → 0.41.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
@@ -1,6 +1,6 @@
1
1
  # Sveltia CMS
2
2
 
3
- Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and Decap CMS. In some simple cases, migration is as easy as a single line of code change, although we are still working on improving compatibility. The free, open source, UX-focused alternative to Netlify/Decap CMS is now in public beta with more features to come.
3
+ Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, quick replacement for Netlify CMS and Decap CMS. In some simple cases, migration is as easy as a single line of code change, although we are still working on improving compatibility. The free, open source alternative to Netlify/Decap CMS is now in public beta, offering a slew of improvements in UX, performance, i18n support and more.
4
4
 
5
5
  ![Screenshot: Open Source Git-based Headless CMS](https://raw.githubusercontent.com/sveltia/sveltia-cms/main/docs/screenshot-1-20240507.webp)<br>
6
6
 
@@ -152,7 +152,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
152
152
  - Provides a smoother user experience in the Content Editor:
153
153
  - 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].
154
154
  - Click once (the Save button) instead of twice (Publish > Publish now) to save an entry.
155
- - The editor closes automatically when an entry is saved. This behaviour can be changed in Settings.
155
+ - The editor closes automatically when an entry is saved. This behaviour can be changed in the application settings.
156
156
  - Uploading files can be done with drag and drop[^20].
157
157
  - You can upload multiple files at once to the Asset Library[^5].
158
158
  - You can delete multiple entries and assets at once.
@@ -204,7 +204,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
204
204
  - Configuration
205
205
  - The [i18n limitations](https://decapcms.org/docs/i18n/#limitations) in Netlify/Decap CMS do not apply to Sveltia CMS:
206
206
  - File collections support multiple files/folders i18n structures[^87]. To enable it, simply use the `{{locale}}` template tag in the `file` path option, e.g. `content/pages/about.{{locale}}.json` or `content/pages/{{locale}}/about.json`. For backward compatibility, the global `structure` option only applies to folder collections as before.
207
- - The `i18n: duplicate` field configuration can be used for the List and Object widgets so that changes made with these widgets are duplicated between locales[^7][^68].
207
+ - The `i18n: duplicate` field configuration can be used for the List and Object widgets so that changes made with these widgets are duplicated between locales[^7][^68]. Subfields can use the `i18n` configuration normally.
208
208
  - [Entry-relative media folders](https://decapcms.org/docs/collection-folder/#media-and-public-folder) can be used in conjunction with the `multiple_folders` i18n structure[^21].
209
209
  - You can use the `{{locale}}` template tag in the [`preview_path`](https://decapcms.org/docs/configuration-options/#preview_path) collection option to provide site preview links for each language[^63].
210
210
  - You can [use a random UUID for an entry slug](#using-a-random-id-for-an-entry-slug), which is a good option for locales that write in non-Latin characters.
@@ -217,6 +217,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
217
217
  - Language labels appear in human-readable display names instead of ISO 639 language codes because it’s not easy for everyone to recognize `DE` as German, `NL` as Dutch, `ZH` as Chinese, and so on.
218
218
  - Content editing
219
219
  - [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.
220
+ - The Content Editor supports [RTL scripts](https://en.wikipedia.org/wiki/Right-to-left_script) such as Arabic, Hebrew and Persian[^146].
220
221
  - You can [disable non-default locale content](#disabling-non-default-locale-content)[^15].
221
222
  - Boolean, DateTime, List and Number fields in the entry preview are displayed in a localized format.
222
223
  - Boolean fields are updated in real time between locales like other widgets to avoid confusion[^35].
@@ -385,7 +386,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
385
386
 
386
387
  ### Better localization
387
388
 
388
- - The application UI locale is automatically selected based on the preferred language set with the browser[^132]. Users can also change the locale in the Settings. Therefore, the `locale` configuration option is ignored and `CMS.registerLocale()` is not required.
389
+ - The application UI locale is automatically selected based on the preferred language set with the browser[^132]. Users can also change the locale in the application settings. Therefore, the `locale` configuration option is ignored and `CMS.registerLocale()` is not required.
389
390
  - 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].
390
391
  - Long menu item labels, especially in non-English locales, don’t overflow the dropdown container[^117].
391
392
  - We’ll soon be migrating from [svelte-i18n](https://github.com/kaisermann/svelte-i18n) to the [Fluent localization system](https://projectfluent.org/) for natural-sounding translations in every locale.
@@ -416,13 +417,11 @@ These limitations are expected to be resolved before or shortly after GA:
416
417
  | Configuration | Comprehensive config validation is not yet implemented. |
417
418
  | Localization | The application UI is only available in English and Japanese at this time. |
418
419
  | Media Libraries | Cloudinary and Uploadcare are not yet supported. |
419
- | Workflow | Editorial Workflow and Open Authoring are not yet supported. |
420
- | Collections | Nested Collections are not yet supported. |
420
+ | Workflow | Editorial Workflow and Open Authoring are not yet supported and will be implemented after the 1.0 release. |
421
+ | Collections | Nested Collections are not yet supported and will be implemented after the 1.0 release. |
421
422
  | Widgets | Custom widgets are not yet supported. See the table below for other limitations. |
422
423
  | Customizations | Custom previews, custom formatters and event subscriptions are not yet supported. |
423
424
 
424
- Open Authoring and Nested Collections will be implemented after the 1.0 release.
425
-
426
425
  | Widget | Status in Sveltia CMS |
427
426
  | --- | --- |
428
427
  | Code | Not yet supported. |
@@ -619,7 +618,7 @@ In Sveltia CMS, those per-collection media folders are displayed prominently for
619
618
 
620
619
  ### Using DeepL to translate entry fields
621
620
 
622
- Sveltia CMS comes with a handy DeepL integration so that you can translate any text field from another locale without leaving the content editor. To enable the high quality, AI-powered, quick translation feature:
621
+ Sveltia CMS comes with a handy DeepL integration so that you can translate any text field from another locale without leaving the Content Editor. To enable the high quality, AI-powered, quick translation feature:
623
622
 
624
623
  1. Update your configuration file to enable the [i18n support](https://decapcms.org/docs/i18n/) with multiple locales.
625
624
  1. Sign up for [DeepL API](https://www.deepl.com/pro-api/) and copy your Authentication Key from DeepL’s Account page.
@@ -697,7 +696,7 @@ i18n:
697
696
 
698
697
  ### Disabling non-default locale content
699
698
 
700
- You can disable output of content in selected non-default locales by adding the `save_all_locales` property to the top-level or per-collection `i18n` configuration. Then you’ll find “Disable (locale name)” in the three-dot menu in the top right corner of the content editor. This is useful if the translation isn’t ready yet, but you want to publish the default locale content first.
699
+ You can disable output of content in selected non-default locales by adding the `save_all_locales` property to the top-level or per-collection `i18n` configuration. Then you’ll find “Disable (locale name)” in the three-dot menu in the top right corner of the Content Editor. This is useful if the translation isn’t ready yet, but you want to publish the default locale content first.
701
700
 
702
701
  With the following configuration, you can disable the French and/or German translation while writing in English.
703
702
 
@@ -739,7 +738,7 @@ With Sveltia CMS, you can disable automatic deployments by default and manually
739
738
  ```
740
739
  1. Commit and deploy the change to the config file and reload the CMS.
741
740
  1. Now, whenever you save an entry or asset, `[skip ci]` is automatically added to each commit message. However, deletions are always committed without the prefix to avoid unexpected data retention on your site.
742
- 1. If you want to deploy a new or updated entry, as well as any other unpublished entries and assets, click an arrow next to the Save button in the content editor, then select **Save and Publish**. This will trigger CI/CD by omitting `[skip ci]`.
741
+ 1. If you want to deploy a new or updated entry, as well as any other unpublished entries and assets, click an arrow next to the Save button in the Content Editor, then select **Save and Publish**. This will trigger CI/CD by omitting `[skip ci]`.
743
742
 
744
743
  If you set `automatic_deployments` to `true`, the behaviour is reversed. CI/CD will be triggered by default, while you have an option to **Save without Publishing** that adds `[skip ci]` only to the associated commit.
745
744
 
@@ -1197,3 +1196,5 @@ This software is provided “as is” without any express or implied warranty. W
1197
1196
  [^144]: Netlify/Decap CMS [#3284](https://github.com/decaporg/decap-cms/issues/3284)
1198
1197
 
1199
1198
  [^145]: Netlify/Decap CMS [#4733](https://github.com/decaporg/decap-cms/issues/4733)
1199
+
1200
+ [^146]: Netlify/Decap CMS [#2524](https://github.com/decaporg/decap-cms/issues/2524)