@sveltia/cms 0.9.8 → 0.10.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.
Files changed (4) hide show
  1. package/LICENSE.txt +1 -1
  2. package/README.md +20 -45
  3. package/dist/sveltia-cms.js +160 -158
  4. package/package.json +16 -15
package/LICENSE.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2023 Kohei Yoshino.
3
+ Copyright (c) 2024 Kohei Yoshino.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -72,8 +72,8 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
72
72
  - [Integrates DeepL](#use-deepl-to-translate-entry-fields) to allow translation of text fields from another locale with one click.
73
73
  - You can [disable non-default locale content](#disable-non-default-locale-content)[^15].
74
74
  - You can [use a random UUID for an entry slug](#use-a-random-id-for-an-entry-slug), which is a good option for locales that write in non-Latin characters[^12].
75
- - Resolves the [limitations in the list and object widgets](https://decapcms.org/docs/beta-features/#i18n-support) so that changes made with these widgets will be duplicated between locales as expected when using the `i18n: duplicate` field configuration[^7].
76
- - [Entry-relative media folders](https://decapcms.org/docs/beta-features/#folder-collections-media-and-public-folder) can be used in conjunction with the `multiple_folders` i18n structure[^21].
75
+ - Resolves the [limitations in the list and object widgets](https://decapcms.org/docs/i18n/#limitations) so that changes made with these widgets will be duplicated between locales as expected when using the `i18n: duplicate` field configuration[^7].
76
+ - [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].
77
77
 
78
78
  ### Better collections
79
79
 
@@ -104,20 +104,21 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
104
104
 
105
105
  ## Compatibility
106
106
 
107
- While it’s not our goal to recreate all the features found in Netlify/Decap CMS, we plan to maximize compatibility before the 1.0 release so that more users can migrate to our modern alternative.
107
+ While it’s not our goal to recreate all the features found in Netlify/Decap CMS, we plan to maximize compatibility before the 1.0 release so that more users can migrate to our modern alternative. The table below is a summary of the current limitations of Sveltia CMS:
108
108
 
109
109
  | Feature | Status in Sveltia CMS |
110
110
  | --- | --- |
111
111
  | Installation | Installing with npm is not supported yet. |
112
- | UI locales | Only English and Japanese are available at this time. No registration is needed. While the UI locale is automatically selected depending on the browser’s language settings, it can be changed in Settings. (Click on the Account button in the top right corner of the CMS.) |
113
- | Account | Only the [GitHub backend](https://decapcms.org/docs/github-backend/) is available at this time. You can keep using Netlify or a [3rd party OAuth client](https://decapcms.org/docs/external-oauth-clients/) (or [our own](https://github.com/sveltia/sveltia-cms-auth)) to sign in with GitHub, just like Netlify/Decap CMS. The GitLab backend is coming soon. We plan to add the Test backend as well for our demo site, but Azure, Bitbucket and Git Gateway will probably not be supported, mainly due to the lack of a method to fetch content in bulk. We have not looked into the relatively new Gitea backend yet. Later we may implement a performant Git Gateway alternative using GraphQL. |
114
- | Configuration | Supported. |
115
- | Media | External media storage services are not supported yet. Deprecated Netlify Large Media won’t be added. |
112
+ | Backends | Only the GitHub backend is available at this time. Sveltia CMS uses the GraphQL by default for a better performance; it cannot be disabled. The GitLab backend will be available soon. We plan to add the Test backend as well for our demo site as well, but Azure and Bitbucket will probably not be supported, mainly due to the lack of a method to fetch content in bulk. We have not looked into the relatively new Gitea backend yet. |
113
+ | Netlify Integration | Identity Widget is not supported yet. We will not support Git Gateway due to the poor performance; we may implement an alternative using GraphQL later. |
114
+ | Local Git Repository | Supported using a different approach. [See below](#work-with-a-local-git-repository) for details. |
115
+ | UI Locales | Only English and Japanese are available at this time. No registration is needed. While the UI locale is automatically selected depending on the browser’s language settings, it can be changed in Settings. (Click on the Account button in the top right corner of the CMS.) |
116
+ | Media Libraries | External media storage services are not supported yet. We will add support for Cloudinary and Uploadcare in a better way, but will not support deprecated Netlify Large Media. |
116
117
  | Editorial Workflow | Not supported yet. |
117
- | Collections | Supported. |
118
+ | Open Authoring | Not supported yet. |
119
+ | Collections | Nested collections are not supported yet. |
118
120
  | Widgets | [See below](#widget-limitations) for the current limitations. |
119
- | Custom widgets | Not supported yet. |
120
- | Custom previews | Not supported yet. |
121
+ | Customizations | Custom widgets, custom previews, custom formatters, manual initialization and CMS event subscriptions are not supported yet. |
121
122
 
122
123
  ### Widget limitations
123
124
 
@@ -125,41 +126,15 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
125
126
  | --- | --- |
126
127
  | Code | Not supported yet. |
127
128
  | Color | The `enableAlpha` option is not supported yet. |
128
- | Date/DateTime | The `date_format` and `time_format` options with Moment.js tokens are not supported yet. We may deprecate the Moment.js format support anyway. |
129
+ | Date | Sveltia CMS has dropped the support for it following Decap CMS 3.0. Use the DateTime widget instead. |
130
+ | DateTime | The `date_format` and `time_format` options with Moment.js tokens are not supported yet. Note: Decap CMS 3.1 has replaced Moment.js with [Day.js](https://day.js.org/); we’ll follow the change soon. |
129
131
  | File/Image | Field-specific media folders and media library options are not supported yet other than `media_library.config.max_file_size` for the default media library. |
130
132
  | Map | Not supported yet. |
131
- | Markdown | It’s a plain text editor at this time. A rich text editor is coming soon. |
133
+ | Markdown | It’s a plain text editor at this time. A rich text editor is coming soon. We will not support Remark plugins. |
132
134
  | Relation | The `search_fields` option is not supported yet. |
133
135
 
134
- ### Beta features in Netlify/Decap CMS
135
-
136
- | Feature | Status in Sveltia CMS |
137
- | --- | --- |
138
- | Working with a Local Git Repository | Supported. [See below](#work-with-a-local-git-repository) for details. |
139
- | GitLab and BitBucket Editorial Workflow Support | Editorial workflow is not supported yet. |
140
- | i18n Support | Supported. In fact, i18n is at the core of Sveltia CMS! |
141
- | GitHub GraphQL API | Supported. Sveltia CMS uses GraphQL by default for a better performance. It cannot be disabled. |
142
- | GitLab GraphQL API | The GitLab backend is not supported yet. |
143
- | Open Authoring | Not supported yet. |
144
- | Folder Collections Path | Supported. |
145
- | Folder Collections Media and Public Folder | Supported. We recommend using [absolute path per-collection folders](#use-a-custom-media-folder-for-a-collection) for easier asset management rather than relative path per-entry folders. |
146
- | List Widget: Variable Types | Supported. |
147
- | Custom Mount Element | Supported. |
148
- | Manual Initialization | Not supported yet. |
149
- | Raw CSS in registerPreviewStyle | Not supported yet. |
150
- | Squash merge GitHub pull requests | Editorial workflow is not supported yet. |
151
- | Commit Message Templates | Supported. |
152
- | Image widget file size limit | Supported. |
153
- | Summary string template transformations | Supported. |
154
- | Registering to CMS Events | Not supported yet. |
155
- | Dynamic Default Values | Supported. |
156
- | Nested Collections | Not supported yet. |
157
- | Remark plugins | Not supported yet. |
158
- | Custom formatters | Not supported yet. |
159
-
160
136
  ### Other features
161
137
 
162
- - Netlify Identity Widget is not supported yet.
163
138
  - Comprehensive config validation is not implemented yet.
164
139
  - Auto-saving a draft entry is not implemented yet.
165
140
  - Downloading an asset and copying the file path of an asset in the media library is not implemented yet.
@@ -187,7 +162,7 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
187
162
 
188
163
  ### New users
189
164
 
190
- Currently, Sveltia CMS is only intended for existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://decapcms.org/docs/add-to-your-site/) to add it to your site and create a configuration file first. Then migrate to Sveltia CMS as described below.
165
+ Currently, Sveltia CMS is primarily intended for existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://decapcms.org/docs/basic-steps/) to add it to your site and create a configuration file first. Then migrate to Sveltia CMS as described below.
191
166
 
192
167
  As the product evolves, we’ll implement a built-in configuration editor and provide comprehensive documentation to make it easier for everyone to get started with Sveltia CMS.
193
168
 
@@ -220,13 +195,13 @@ You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](
220
195
 
221
196
  ### Work with a local Git repository
222
197
 
223
- You can use Sveltia CMS with a local Git repository, like the [beta feature](https://decapcms.org/docs/beta-features/#working-with-a-local-git-repository) in Netlify/Decap CMS, but Sveltia CMS has simplified the workflow by removing the need for additional configuration (the `local_backend` property) and 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).
198
+ You can use Sveltia CMS with a local Git repository like [Netlify/Decap CMS](https://decapcms.org/docs/working-with-a-local-git-repository/), but Sveltia CMS has simplified the workflow by removing the need for additional configuration (the `local_backend` property) and 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).
224
199
 
225
200
  1. Launch the local development server for your frontend framework, typically with `npm run dev` or `pnpm dev`.
226
201
  1. Visit `http://localhost:[port]/admin/index.html` with Chrome or Edge. The port number varies by framework.
227
202
  - Other Chromium-based browsers may also work. In Brave, you need to enable the File System Access API [with a flag](https://github.com/brave/brave-browser/issues/20563#issuecomment-1021567573).
228
203
  1. Click “Work with Local Repository” and select the project’s root directory once prompted.
229
- - 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).
204
+ - 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).
230
205
  1. Make some changes to your content on Sveltia CMS.
231
206
  1. See if the produced changes look good using `git diff` or a GUI like [GitHub Desktop](https://desktop.github.com/).
232
207
  1. Open the dev site at `http://localhost:[port]/` to check the rendered pages.
@@ -255,7 +230,7 @@ You can have an icon for each collection for easy identification in the collecti
255
230
 
256
231
  ### Use a custom media folder for a collection
257
232
 
258
- This is actually not new in Sveltia CMS but rather an _undocumented_ feature in Netlify/Decap CMS[^4]. You can specify media and public folders for each collection that override the [global media folder](https://decapcms.org/docs/configuration-options/#media-and-public-folders). Well, it’s [documented](https://decapcms.org/docs/beta-features/#folder-collections-media-and-public-folder) as a beta feature, but that’s probably not what you want.
233
+ This is actually not new in Sveltia CMS but rather an _undocumented_ feature in Netlify/Decap CMS[^4]. You can specify media and public folders for each collection that override the [global media folder](https://decapcms.org/docs/configuration-options/#media-and-public-folders). Well, it’s [documented](https://decapcms.org/docs/collection-folder/#media-and-public-folder), but that’s probably not what you want.
259
234
 
260
235
  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 an _absolute path_ for `media_folder` like the example below. You can try this with Netlify/Decap CMS first if you prefer.
261
236
 
@@ -278,7 +253,7 @@ In Sveltia CMS, those per-collection media folders are displayed prominently for
278
253
 
279
254
  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, quick translation feature:
280
255
 
281
- 1. Update your configuration file to enable the [i18n support](https://decapcms.org/docs/beta-features/#i18n-support) with multiple locales.
256
+ 1. Update your configuration file to enable the [i18n support](https://decapcms.org/docs/i18n/) with multiple locales.
282
257
  1. Sign up for [DeepL API](https://www.deepl.com/pro-api/) and copy your Authentication Key from DeepL’s Account page.
283
258
  1. Go back to Sveltia CMS, click on the Account button in the top right corner, then click Settings.
284
259
  1. Paste your key to the DeepL API Authentication Key field, and close the Settings dialog.
@@ -456,7 +431,7 @@ This software is provided “as is” without any express or implied warranty. W
456
431
  [^14]: [Netlify/Decap CMS #4635](https://github.com/decaporg/decap-cms/issues/4635), [#4738](https://github.com/decaporg/decap-cms/issues/4738), [#5920](https://github.com/decaporg/decap-cms/issues/5920), [#6410](https://github.com/decaporg/decap-cms/issues/6410)
457
432
  [^15]: [Netlify/Decap CMS #6932](https://github.com/decaporg/decap-cms/issues/6932)
458
433
  [^16]: [Netlify/Decap CMS #2103](https://github.com/decaporg/decap-cms/issues/2103)
459
- [^17]: [Netlify/Decap CMS #1333](https://github.com/decaporg/decap-cms/issues/1333)
434
+ [^17]: [Netlify/Decap CMS #1333](https://github.com/decaporg/decap-cms/issues/1333), [#7077](https://github.com/decaporg/decap-cms/issues/7077)
460
435
  [^18]: [Netlify/Decap CMS #441](https://github.com/decaporg/decap-cms/issues/441)
461
436
  [^19]: [Netlify/Decap CMS #5910](https://github.com/decaporg/decap-cms/issues/5910)
462
437
  [^20]: [Netlify/Decap CMS #4563](https://github.com/decaporg/decap-cms/issues/4563)