@sveltia/cms 0.60.6 → 0.61.0
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 +99 -80
- package/dist/sveltia-cms.js +199 -199
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +198 -198
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -41,8 +41,7 @@ The free, open source alternative to Netlify/Decap CMS is now in public beta, tu
|
|
|
41
41
|
- [Better localization](#better-localization)
|
|
42
42
|
- [Compatibility](#compatibility)
|
|
43
43
|
- [Features not to be implemented](#features-not-to-be-implemented)
|
|
44
|
-
- [
|
|
45
|
-
- [Features to be implemented after GA](#features-to-be-implemented-after-ga)
|
|
44
|
+
- [Current limitations](#current-limitations)
|
|
46
45
|
- [Compatibility with Static CMS](#compatibility-with-static-cms)
|
|
47
46
|
- [Other notes](#other-notes)
|
|
48
47
|
- [Getting started](#getting-started)
|
|
@@ -67,6 +66,7 @@ The free, open source alternative to Netlify/Decap CMS is now in public beta, tu
|
|
|
67
66
|
- [Disabling non-default locale content](#disabling-non-default-locale-content)
|
|
68
67
|
- [Using a random ID for an entry slug](#using-a-random-id-for-an-entry-slug)
|
|
69
68
|
- [Editing data files with a top-level list](#editing-data-files-with-a-top-level-list)
|
|
69
|
+
- [Changing the input type of a DateTime field](#changing-the-input-type-of-a-datetime-field)
|
|
70
70
|
- [Controlling data output](#controlling-data-output)
|
|
71
71
|
- [Disabling automatic deployments](#disabling-automatic-deployments)
|
|
72
72
|
- [Setting up Content Security Policy](#setting-up-content-security-policy)
|
|
@@ -115,10 +115,10 @@ Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in
|
|
|
115
115
|
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 that require considerable effort:
|
|
116
116
|
|
|
117
117
|
- Ensuring substantial [compatibility with Netlify/Decap CMS](#compatibility)
|
|
118
|
-
- We even
|
|
118
|
+
- We even proactively adopt changes suggested in their [pull requests](https://github.com/decaporg/decap-cms/pulls) that may sit in the review queue for a long time
|
|
119
119
|
- Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
|
|
120
120
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
121
|
-
- So far, 175+ of them, or
|
|
121
|
+
- So far, 175+ of them, or 345+ including duplicates, have been effectively solved in Sveltia CMS
|
|
122
122
|
- Target: 200 by GA; 300, or 500 including duplicates, in the future (yes, you read that right)
|
|
123
123
|
- Issues include everything from feature requests to bug reports and [issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) or without a real solution, as well as [discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
124
124
|
- Most of the bugs, including annoying crashes, are already solved
|
|
@@ -138,7 +138,7 @@ We hope Netlify/Decap CMS users will be pleased and surprised by the numerous im
|
|
|
138
138
|
|
|
139
139
|
- 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.
|
|
140
140
|
- The maintainer tries to be as responsive as possible. While there are no guarantees, the typical turnaround time for a bug fix is less than 24 hours.
|
|
141
|
-
-
|
|
141
|
+
- Frequent releases deliver new features and enhancements to users more quickly.
|
|
142
142
|
- Offers a modern, intuitive user interface that utilizes the full viewport,[^178] inspired in part by the Netlify CMS v3 prototype.[^1]
|
|
143
143
|
- Provides immersive dark mode.[^2] The UI theme follows the user’s system preference by default and can be changed in the application settings.
|
|
144
144
|
- 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.
|
|
@@ -152,7 +152,7 @@ We hope Netlify/Decap CMS users will be pleased and surprised by the numerous im
|
|
|
152
152
|
|
|
153
153
|
- Built completely from scratch with [Svelte](https://svelte.dev/) 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 or static site generator (SSG) that can load static data files during the build process.
|
|
154
154
|
- Small footprint: The bundle size is less than 500 KB when minified and [brotlied](https://en.wikipedia.org/wiki/Brotli), which is much lighter than Netlify CMS (1.5 MB), Decap CMS (1.9 MB) and Static CMS (2.6 MB).[^57][^64] This number is remarkable because even though we haven’t implemented some features yet, we have added a lot of new features. That’s the power of Svelte + [Vite](https://vite.dev/).
|
|
155
|
-
- We have upgraded from Svelte 4 to [Svelte 5](https://svelte.dev/blog/svelte-5-is-alive) to further improve performance, including an even smaller bundle size.
|
|
155
|
+
- We have upgraded from Svelte 4 to [Svelte 5](https://svelte.dev/blog/svelte-5-is-alive) to further improve performance, including an even smaller bundle size.
|
|
156
156
|
- [No virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
157
157
|
- 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] (the useless `search` configuration option is therefore ignored). It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets.[^14]
|
|
158
158
|
- 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/).
|
|
@@ -239,6 +239,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
239
239
|
- It’s possible to [localize entry slugs](#localizing-entry-slugs) while linking the localized files,[^80] thanks to the support for Hugo’s `translationKey`.[^81]
|
|
240
240
|
- When the `clean_accents` option is enabled for [entry slugs](https://decapcms.org/docs/configuration-options/#slug-type), certain characters, such as German umlauts, will be [transliterated](https://en.wikipedia.org/wiki/Transliteration).[^99]
|
|
241
241
|
- It’s possible to embed the locale code in an entry by using `widget: hidden` along with `default: '{{locale}}'`.[^101]
|
|
242
|
+
- The `value_field` Relation option can contain a locale prefix like `{{locale}}/{{slug}}`, which will be replaced with the current locale. It’s intended to support i18n in Astro. ([Discussion](https://github.com/sveltia/sveltia-cms/discussions/302#discussioncomment-12005868))
|
|
242
243
|
- User interface
|
|
243
244
|
- Eliminates UI confusion: The Preview Pane can be displayed without toggling i18n in the Content Editor. Both panes are scrollable. There is no condition where both panes are edited in the same language at the same time.
|
|
244
245
|
- Users can easily switch between locales while editing by clicking a button instead of a dropdown list when there are less than 5 locales.
|
|
@@ -373,6 +374,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
373
374
|
- It’s possible to [edit data files with a top-level list](#editing-data-files-with-a-top-level-list) using the new `root` option.[^148]
|
|
374
375
|
- The `min` and `max` options can be used separately. You don’t need to specify both to use either option.[^145]
|
|
375
376
|
- The Add Item button appears at the bottom of the list when the `add_to_top` option is not `true`, so you don’t have to scroll up each time to add new items.
|
|
377
|
+
- A list item comes with a menu that allows users to duplicate the item, insert a new item above/below it, or remove it.[^187]
|
|
376
378
|
- Users can expand or collapse the entire list, while the Expand All and Collapse All buttons allow you to expand or collapse all items in the list at once.[^164]
|
|
377
379
|
- A required List field with no subfield or value is marked as invalid.[^43] No need to set the `min` and `max` options for the `required` option to work.
|
|
378
380
|
- An optional List field with no subfield or value is saved as an empty array, rather than nothing.[^44]
|
|
@@ -437,8 +439,8 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
437
439
|
#### New widgets
|
|
438
440
|
|
|
439
441
|
- Compute
|
|
440
|
-
- The experimental `compute` widget allows to reference the value of other fields in the same collection, similar to the `summary` property for the List and Object widgets.[^104] Use the `value` property to define the value template, e.g. `posts-{{fields.slug}}
|
|
441
|
-
- The `value` property also supports a value of `{{index}}`, which can hold the index of a list item ([
|
|
442
|
+
- The experimental `compute` widget allows to reference the value of other fields in the same collection, similar to the `summary` property for the List and Object widgets.[^104] Use the `value` property to define the value template, e.g. `posts-{{fields.slug}}`. ([Example](https://github.com/sveltia/sveltia-cms/issues/111))
|
|
443
|
+
- The `value` property also supports a value of `{{index}}`, which can hold the index of a list item. ([Example](https://github.com/sveltia/sveltia-cms/issues/172))
|
|
442
444
|
- KeyValue (Dictionary)
|
|
443
445
|
- The new `keyvalue` widget allows users to add arbitrary key-value string pairs to a field.[^123]
|
|
444
446
|
- While the implementation is compatible with [Static CMS](https://staticjscms.netlify.app/docs/widget-keyvalue), we provide a more intuitive UI. You can press Enter to move focus or add a new row while editing, and the preview is displayed in a clean table.
|
|
@@ -492,39 +494,32 @@ However, 100% feature parity is not planned, and some features are still missing
|
|
|
492
494
|
|
|
493
495
|
### Features not to be implemented
|
|
494
496
|
|
|
495
|
-
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends
|
|
496
|
-
- **Netlify Identity Widget
|
|
497
|
-
- The deprecated client-side implicit grant for the GitLab backend
|
|
498
|
-
- The deprecated Netlify Large Media service
|
|
499
|
-
- The deprecated Date widget
|
|
500
|
-
- The theme and keymap inline settings of the Code widget
|
|
501
|
-
- Remark plugins
|
|
502
|
-
- [Undocumented methods](https://github.com/sveltia/sveltia-cms/blob/c69446da7bb0bab7405be741c0f92850c5dddfa8/src/main.js#L14-L37) exposed on the `window.CMS` object
|
|
503
|
-
- An absolute URL for the [`public_folder`](https://decapcms.org/docs/configuration-options/#public-folder) option
|
|
504
|
-
|
|
505
|
-
###
|
|
506
|
-
|
|
507
|
-
These
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
| [File](https://decapcms.org/docs/widgets/#file) / [Image](https://decapcms.org/docs/widgets/#image) | Field-specific media folders (beta) and media library options are not yet supported other than `media_library.config.max_file_size` for the default media library. |
|
|
522
|
-
| [Map](https://decapcms.org/docs/widgets/#map) | Not yet implemented. |
|
|
523
|
-
| [Markdown](https://decapcms.org/docs/widgets/#markdown) | Custom components are not yet supported. |
|
|
524
|
-
|
|
525
|
-
### Features to be implemented after GA
|
|
526
|
-
|
|
527
|
-
Due to the complexity, the following features are planned for after the 1.0 release. Netlify/Decap CMS has a number of open issues with these collaboration and beta features — we want to implement them the right way.
|
|
497
|
+
- **The Bitbucket, Gitea/Forgejo and Git Gateway backends**: 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. We may also support the other platforms if their APIs improve to allow the CMS to fetch multiple entries at once.
|
|
498
|
+
- **Netlify Identity Widget**: It’s not useful without Git Gateway, and Netlify Identity 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/).
|
|
499
|
+
- 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.
|
|
500
|
+
- The deprecated Netlify Large Media service: Consider other storage providers.
|
|
501
|
+
- The deprecated Date widget: It has already been removed from Decap CMS 3.0. Use the DateTime widget with the [`time_format: false` option](#changing-the-input-type-of-a-datetime-field) instead.
|
|
502
|
+
- The theme and keymap inline settings of the Code widget plus some languages: We use the [Prism](https://prismjs.com/)-powered code block functionality in Lexical instead of [CodeMirror](https://codemirror.net/).
|
|
503
|
+
- Remark plugins: Not compatible with our Lexical-based rich text editor.
|
|
504
|
+
- [Undocumented methods](https://github.com/sveltia/sveltia-cms/blob/c69446da7bb0bab7405be741c0f92850c5dddfa8/src/main.js#L14-L37) exposed on the `window.CMS` object: This includes custom backends and custom media libraries, if any. We may support these features in the future, but our implementation would likely be incompatible with Netlify/Decap CMS.
|
|
505
|
+
- An absolute URL for the [`public_folder`](https://decapcms.org/docs/configuration-options/#public-folder) option: Such configuration is not recommended, as stated in the Netlify/Decap CMS document.
|
|
506
|
+
|
|
507
|
+
### Current limitations
|
|
508
|
+
|
|
509
|
+
These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release scheduled for early 2025.
|
|
510
|
+
|
|
511
|
+
- Comprehensive site config validation
|
|
512
|
+
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) other than English and Japanese
|
|
513
|
+
- [Azure](https://decapcms.org/docs/azure-backend/) and [Test](https://decapcms.org/docs/test-backend/) backends (Azure may not be supported for performance reasons)
|
|
514
|
+
- [DateTime](https://decapcms.org/docs/widgets/#datetime) widget: The `date_format` and `time_format` options with Moment.js tokens (Note: [Decap CMS 3.1.1](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.1.1) replaced [Moment.js](https://momentjs.com/) with [Day.js](https://day.js.org/), and [Decap CMS 3.3.0](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.3.0) made some additional updates — We’ll follow these changes where it makes sense)
|
|
515
|
+
- [File](https://decapcms.org/docs/widgets/#file) and [Image](https://decapcms.org/docs/widgets/#image) widgets: Field-specific media folders and media library options other than `max_file_size` for the default media library
|
|
516
|
+
- [Map](https://decapcms.org/docs/widgets/#map) widget
|
|
517
|
+
- [Cloudinary](https://decapcms.org/docs/cloudinary/) and [Uploadcare](https://decapcms.org/docs/uploadcare/) media libraries
|
|
518
|
+
- [Custom widgets and custom editor components](https://decapcms.org/docs/custom-widgets/)
|
|
519
|
+
- [Custom previews](https://decapcms.org/docs/customization/)
|
|
520
|
+
- [Event subscriptions](https://decapcms.org/docs/registering-events/)
|
|
521
|
+
|
|
522
|
+
Due to the complexity, the following features are planned for after the 1.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.
|
|
528
523
|
|
|
529
524
|
- [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
530
525
|
- [Open Authoring](https://decapcms.org/docs/open-authoring/)
|
|
@@ -692,12 +687,13 @@ You can specify an icon for each collection for easy identification in the colle
|
|
|
692
687
|
1. Commit and push the changes to your Git repository.
|
|
693
688
|
1. Reload Sveltia CMS once the updated config file is deployed.
|
|
694
689
|
|
|
695
|
-
```
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
690
|
+
```yaml
|
|
691
|
+
fields:
|
|
692
|
+
- name: tags
|
|
693
|
+
label: Tags
|
|
694
|
+
icon: sell # or any icon name
|
|
695
|
+
create: true
|
|
696
|
+
folder: data/tags/
|
|
701
697
|
```
|
|
702
698
|
|
|
703
699
|
### Adding dividers to the collection list
|
|
@@ -721,17 +717,16 @@ This is actually not new in Sveltia CMS but rather an undocumented feature in Ne
|
|
|
721
717
|
|
|
722
718
|
Rather, if you’d like to add all the media files for a collection in one single folder, specify both `media_folder` and `public_folder` instead of leaving them empty. The trick is to use a **project relative path starting with a slash** for `media_folder` like the example below. You can try this with Netlify/Decap CMS first if you prefer.
|
|
723
719
|
|
|
724
|
-
```
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
+ public_folder: /media/products
|
|
720
|
+
```yaml
|
|
721
|
+
media_folder: static/media # leading slash is optional
|
|
722
|
+
public_folder: /media
|
|
723
|
+
|
|
724
|
+
collections:
|
|
725
|
+
- name: products
|
|
726
|
+
label: Products
|
|
727
|
+
folder: data/products/
|
|
728
|
+
media_folder: /static/media/products # make sure to append a slash
|
|
729
|
+
public_folder: /media/products
|
|
735
730
|
```
|
|
736
731
|
|
|
737
732
|
In Sveltia CMS, those collection media folders are displayed prominently for easier asset management. We recommend setting `media_folder` and `public_folder` for each collection if it contains one or more File/Image fields.
|
|
@@ -875,12 +870,11 @@ By default, the [slug for a new entry file](https://decapcms.org/docs/configurat
|
|
|
875
870
|
|
|
876
871
|
It’s simple — just specify `{{uuid}}` (full UUID v4), `{{uuid_short}}` (last 12 characters only) or `{{uuid_shorter}}` (first 8 characters only) in the `slug` option. The results would look like `4fc0917c-8aea-4ad5-a476-392bdcf3b642`, `392bdcf3b642` and `4fc0917c`, respectively.
|
|
877
872
|
|
|
878
|
-
```
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
+ slug: '{{uuid_short}}'
|
|
873
|
+
```yaml
|
|
874
|
+
collections:
|
|
875
|
+
- name: members
|
|
876
|
+
label: Members
|
|
877
|
+
slug: '{{uuid_short}}' # or {{uuid}} or {{uuid_shorter}}
|
|
884
878
|
```
|
|
885
879
|
|
|
886
880
|
### Editing data files with a top-level list
|
|
@@ -910,6 +904,30 @@ collections:
|
|
|
910
904
|
|
|
911
905
|
Note: The `root` option is ignored if the collection or collection file contains multiple fields. You can still have subfields under the List field.
|
|
912
906
|
|
|
907
|
+
### Changing the input type of a DateTime field
|
|
908
|
+
|
|
909
|
+
It may be worth mentioning this topic here because the current [Decap CMS doc about the DateTime widget](https://decapcms.org/docs/widgets/#datetime) is unclear. By default, a DateTime field lets users pick both [date and time](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local), but developers can change the input type if needed.
|
|
910
|
+
|
|
911
|
+
Use `time_format: false` to hide the time picker and make it [date only](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date):
|
|
912
|
+
|
|
913
|
+
```yaml
|
|
914
|
+
- label: Start Date
|
|
915
|
+
name: startDate
|
|
916
|
+
widget: datetime
|
|
917
|
+
time_format: false
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
Use `date_format: false` to hide the date picker and make it [time only](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/time):
|
|
921
|
+
|
|
922
|
+
```yaml
|
|
923
|
+
- label: Start Time
|
|
924
|
+
name: startTime
|
|
925
|
+
widget: datetime
|
|
926
|
+
date_format: false
|
|
927
|
+
```
|
|
928
|
+
|
|
929
|
+
We understand that this configuration may be a bit confusing, but it’s necessary to maintain backward compatibility with Netlify CMS. We plan to improve the widget options and introduce new input types: [month](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/month) and [week](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/week).
|
|
930
|
+
|
|
913
931
|
### Controlling data output
|
|
914
932
|
|
|
915
933
|
Sveltia CMS supports some [data output](#better-data-output) options, including JSON/YAML formatting preferences, at the root level of the configuration file. The default options are listed below:
|
|
@@ -932,12 +950,12 @@ You may already have a CI/CD tool set up on your Git repository to automatically
|
|
|
932
950
|
With Sveltia CMS, you can disable automatic deployments by default and manually trigger deployments at your convenience. This is done by adding the `[skip ci]` prefix to commit messages, the convention supported by [GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs), [GitLab CI/CD](https://docs.gitlab.com/ee/ci/pipelines/#skip-a-pipeline), [CircleCI](https://circleci.com/docs/skip-build/#skip-jobs), [Travis CI](https://docs.travis-ci.com/user/customizing-the-build/#skipping-a-build), [Netlify](https://docs.netlify.com/site-deploys/manage-deploys/#skip-a-deploy), [Cloudflare Pages](https://developers.cloudflare.com/pages/platform/branch-build-controls/#skip-builds) and others. Here are the steps to use it:
|
|
933
951
|
|
|
934
952
|
1. Add the new `automatic_deployments` property to your `backend` configuration with a value of `false`:
|
|
935
|
-
```
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
953
|
+
```yaml
|
|
954
|
+
backend:
|
|
955
|
+
name: github
|
|
956
|
+
repo: owner/repo
|
|
957
|
+
branch: main
|
|
958
|
+
automatic_deployments: false
|
|
941
959
|
```
|
|
942
960
|
1. Commit and deploy the change to the config file and reload the CMS.
|
|
943
961
|
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.
|
|
@@ -951,12 +969,12 @@ If the `automatic_deployments` property is defined, you can manually trigger a d
|
|
|
951
969
|
|
|
952
970
|
- GitHub Actions:
|
|
953
971
|
1. Without any configuration, Publish Changes will [trigger a `repository_dispatch` event](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event) with the `sveltia-cms-publish` event type. Update your build workflow to receive this event:
|
|
954
|
-
```
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
972
|
+
```yaml
|
|
973
|
+
on:
|
|
974
|
+
push:
|
|
975
|
+
branches: [$default-branch]
|
|
976
|
+
repository_dispatch:
|
|
977
|
+
types: [sveltia-cms-publish]
|
|
960
978
|
```
|
|
961
979
|
- Other CI/CD providers:
|
|
962
980
|
1. Select Settings under the Account button in the top right corner of the CMS.
|
|
@@ -1078,7 +1096,7 @@ While we don’t have dedicated developer/user support resources, you can post [
|
|
|
1078
1096
|
|
|
1079
1097
|
Hop on [our Discord server](https://discord.gg/5hwCGqup5b) for casual chat.
|
|
1080
1098
|
|
|
1081
|
-
As described throughout this README, Sveltia CMS is being built as a replacement for Netlify/Decap CMS. At this point, we assume that most developers and users are
|
|
1099
|
+
As described throughout this README, Sveltia CMS is being built as a replacement for Netlify/Decap CMS. At this point, we assume that most developers and users are moving from the other product. We are happy to help you migrate, but **we cannot help you set up Sveltia CMS from scratch** through our free support channels.
|
|
1082
1100
|
|
|
1083
1101
|
Planning to build a website with Sveltia CMS? Looking for professional support? Maintainer [@kyoshino](https://github.com/kyoshino) is available for hire depending on your needs. Feel free to reach out!
|
|
1084
1102
|
|
|
@@ -1092,7 +1110,6 @@ See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/ma
|
|
|
1092
1110
|
|
|
1093
1111
|
- Enhanced [compatibility with Netlify/Decap CMS](#compatibility)
|
|
1094
1112
|
- Tackling some more Netlify/Decap CMS issues
|
|
1095
|
-
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md)
|
|
1096
1113
|
- Accessibility audit
|
|
1097
1114
|
- Developer documentation (implementation guide)
|
|
1098
1115
|
- Marketing site
|
|
@@ -1101,7 +1118,7 @@ See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/ma
|
|
|
1101
1118
|
|
|
1102
1119
|
### After the 1.0 release
|
|
1103
1120
|
|
|
1104
|
-
- Implementing the [remaining Netlify/Decap CMS features](#
|
|
1121
|
+
- Implementing the [remaining Netlify/Decap CMS features](#current-limitations)
|
|
1105
1122
|
- Tackling even more Netlify/Decap CMS issues, including MDX support,[^122] manual entry sorting,[^125] mobile optimization,[^18] config editor[^10] and other [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
1106
1123
|
- Exploring features that require server-side implementation, including user management (Netlify Identity alternative), roles,[^23] commits without a GitHub or GitLab account (Git Gateway alternative), post locking (like [WordPress](https://codex.wordpress.org/Post_Locking))[^166] and scheduled posts[^167]
|
|
1107
1124
|
- More integration options: stock photos, stock videos, cloud storage providers, translation services, maps, analytics tools, etc.
|
|
@@ -1355,7 +1372,7 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
1355
1372
|
|
|
1356
1373
|
[^112]: Netlify/Decap CMS [#5815](https://github.com/decaporg/decap-cms/issues/5815), [#6522](https://github.com/decaporg/decap-cms/issues/6522), [#6532](https://github.com/decaporg/decap-cms/issues/6532), [#6588](https://github.com/decaporg/decap-cms/issues/6588), [#6617](https://github.com/decaporg/decap-cms/issues/6617), [#6640](https://github.com/decaporg/decap-cms/issues/6640), [#6663](https://github.com/decaporg/decap-cms/issues/6663), [#6695](https://github.com/decaporg/decap-cms/issues/6695), [#6697](https://github.com/decaporg/decap-cms/issues/6697), [#6764](https://github.com/decaporg/decap-cms/issues/6764), [#6765](https://github.com/decaporg/decap-cms/issues/6765), [#6835](https://github.com/decaporg/decap-cms/issues/6835), [#6983](https://github.com/decaporg/decap-cms/issues/6983), [#7205](https://github.com/decaporg/decap-cms/issues/7205)
|
|
1357
1374
|
|
|
1358
|
-
[^113]: Netlify/Decap CMS [#5656](https://github.com/decaporg/decap-cms/issues/5656), [#5837](https://github.com/decaporg/decap-cms/issues/5837), [#5972](https://github.com/decaporg/decap-cms/issues/5972), [#6476](https://github.com/decaporg/decap-cms/issues/6476), [#6516](https://github.com/decaporg/decap-cms/issues/6516), [#6930](https://github.com/decaporg/decap-cms/issues/6930), [#6965](https://github.com/decaporg/decap-cms/issues/6965), [#7080](https://github.com/decaporg/decap-cms/issues/7080), [#7105](https://github.com/decaporg/decap-cms/issues/7105), [#7106](https://github.com/decaporg/decap-cms/issues/7106), [#7119](https://github.com/decaporg/decap-cms/issues/7119), [#7176](https://github.com/decaporg/decap-cms/issues/7176), [#7194](https://github.com/decaporg/decap-cms/issues/7194), [#7244](https://github.com/decaporg/decap-cms/issues/7244), [#7301](https://github.com/decaporg/decap-cms/issues/7301), [#7342](https://github.com/decaporg/decap-cms/issues/7342), [#7348](https://github.com/decaporg/decap-cms/issues/7348), [#7354](https://github.com/decaporg/decap-cms/issues/7354), [#7376](https://github.com/decaporg/decap-cms/issues/7376), [#7408](https://github.com/decaporg/decap-cms/issues/7408), [#7422](https://github.com/decaporg/decap-cms/issues/7422) — These `removeChild` crashes are common in React apps, likely caused by a [browser extension](https://github.com/facebook/react/issues/17256) or [Google Translate](https://github.com/facebook/react/issues/11538).
|
|
1375
|
+
[^113]: Netlify/Decap CMS [#5656](https://github.com/decaporg/decap-cms/issues/5656), [#5837](https://github.com/decaporg/decap-cms/issues/5837), [#5972](https://github.com/decaporg/decap-cms/issues/5972), [#6476](https://github.com/decaporg/decap-cms/issues/6476), [#6516](https://github.com/decaporg/decap-cms/issues/6516), [#6930](https://github.com/decaporg/decap-cms/issues/6930), [#6965](https://github.com/decaporg/decap-cms/issues/6965), [#7080](https://github.com/decaporg/decap-cms/issues/7080), [#7105](https://github.com/decaporg/decap-cms/issues/7105), [#7106](https://github.com/decaporg/decap-cms/issues/7106), [#7119](https://github.com/decaporg/decap-cms/issues/7119), [#7176](https://github.com/decaporg/decap-cms/issues/7176), [#7194](https://github.com/decaporg/decap-cms/issues/7194), [#7244](https://github.com/decaporg/decap-cms/issues/7244), [#7278](https://github.com/decaporg/decap-cms/issues/7278), [#7301](https://github.com/decaporg/decap-cms/issues/7301), [#7342](https://github.com/decaporg/decap-cms/issues/7342), [#7348](https://github.com/decaporg/decap-cms/issues/7348), [#7354](https://github.com/decaporg/decap-cms/issues/7354), [#7376](https://github.com/decaporg/decap-cms/issues/7376), [#7408](https://github.com/decaporg/decap-cms/issues/7408), [#7412](https://github.com/decaporg/decap-cms/issues/7412), [#7413](https://github.com/decaporg/decap-cms/issues/7413), [#7422](https://github.com/decaporg/decap-cms/issues/7422), [#7427](https://github.com/decaporg/decap-cms/issues/7427) — These `removeChild` crashes are common in React apps, likely caused by a [browser extension](https://github.com/facebook/react/issues/17256) or [Google Translate](https://github.com/facebook/react/issues/11538).
|
|
1359
1376
|
|
|
1360
1377
|
[^114]: Netlify/Decap CMS [#5029](https://github.com/decaporg/decap-cms/issues/5029), [#5048](https://github.com/decaporg/decap-cms/issues/5048)
|
|
1361
1378
|
|
|
@@ -1502,3 +1519,5 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
1502
1519
|
[^185]: Netlify/Decap CMS [#6203](https://github.com/decaporg/decap-cms/issues/6203), [#7417](https://github.com/decaporg/decap-cms/issues/7417)
|
|
1503
1520
|
|
|
1504
1521
|
[^186]: Netlify/Decap CMS [#7379](https://github.com/decaporg/decap-cms/issues/7379)
|
|
1522
|
+
|
|
1523
|
+
[^187]: Netlify/Decap CMS [#1244](https://github.com/decaporg/decap-cms/issues/1244)
|