@sveltia/cms 0.47.0 → 0.47.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 +28 -22
- package/dist/sveltia-cms.js +168 -168
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +195 -195
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
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.
|
|
3
|
+
Sveltia CMS is a Git-based lightweight headless CMS under active development as a modern, powerful, 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.
|
|
4
4
|
|
|
5
|
-
The free, open source alternative to Netlify/Decap CMS is now in public beta, turbocharged with great UX, performance, i18n support and many more enhancements.
|
|
5
|
+
The free, open source alternative to Netlify/Decap CMS is now in public beta, turbocharged with great UX, performance, i18n support and so many more enhancements.
|
|
6
6
|
|
|
7
7
|
<br>
|
|
8
8
|
|
|
@@ -111,7 +111,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
111
111
|
- Target: 150 issues by GA, 250 or all relevant and fixable issues in a future release
|
|
112
112
|
- Note: Issues include both feature requests and bug reports; we also track their [stale issues](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) and [discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
113
113
|
- [Let us know](https://github.com/sveltia/sveltia-cms/issues/new) if you have any specific issues you’d like to see solved!
|
|
114
|
-
- Responding to feedback from clients and regular users
|
|
114
|
+
- Responding to feedback from [@kyoshino](https://github.com/kyoshino)’s clients and regular users
|
|
115
115
|
- Implementing our own enhancement ideas for every part of the product
|
|
116
116
|
|
|
117
117
|
<br>
|
|
@@ -238,25 +238,27 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
238
238
|
- `thumbnail`: Specify the field name for a thumbnail displayed on the entry list[^130]. A nested field can be specified using dot notation, e.g. `images.0.src`. If undefined, the `name` of the first image field is used.
|
|
239
239
|
- Developers can use nested fields (dot notation) in the `path` option for a folder collection, e.g. `{{fields.state.name}}/{{slug}}`[^62].
|
|
240
240
|
- Developers can use Markdown in the `description` collection option[^79]. Bold, italic, strikethrough, code and links are allowed.
|
|
241
|
+
- The collection `folder` can be an empty string (or `.` or `/`) if you want to store entries in the root folder. This supports a typical VitePress setup.
|
|
242
|
+
- A folder collection `filter` supports multiple possible values by using an array for the `value`[^151].
|
|
243
|
+
- Multiple [summary string transformations](https://decapcms.org/docs/summary-strings/) can be chained like `{{title | upper | truncate(20)}}`.
|
|
241
244
|
- Entry slugs
|
|
242
245
|
- It’s possible to [use a random UUID for an entry slug](#using-a-random-id-for-an-entry-slug).
|
|
243
246
|
- Slug generation is fail-safe: If a slug cannot be determined from entry content, part of a random UUID is used instead of throwing an error or filling in with arbitrary string field values[^133].
|
|
244
247
|
- If a collection only has the Markdown `body` field, an entry slug will be generated from a header in the `body`, if exists. This supports a typical VitePress setup.
|
|
245
|
-
- Entry slug template tags support [
|
|
248
|
+
- Entry slug template tags support [transformations](https://decapcms.org/docs/summary-strings/) just like summary string template tags[^29].
|
|
246
249
|
- Single quotes (apostrophes) in a slug will be replaced with `sanitize_replacement` (default: hyphen) rather than being removed[^52].
|
|
247
250
|
- Developers can set the maximum number of characters for an entry slug with the new `slug_length` collection option to avoid deployment errors with Netlify or other platforms[^25].
|
|
248
251
|
- Setting the collection `path` doesn’t affect the entry slugs stored with the Relation widget[^137].
|
|
249
252
|
- Entry slugs are [localizable](#localizing-entry-slugs)[^80].
|
|
250
253
|
- Entry listing
|
|
251
254
|
- The collection list displays the number of items in each collection.
|
|
252
|
-
- A folder collection filter with a boolean value works as expected[^93].
|
|
255
|
+
- A folder collection `filter` with a boolean value works as expected[^93].
|
|
256
|
+
- Sorting entries by a DateTime field works as expected[^110].
|
|
253
257
|
- Entry grouping and sorting can work together. For example, it’s possible to group by year and then sort by year if configured properly.
|
|
254
258
|
- Hugo’s special `_index.md` files, including localized ones like `_index.en.md`, are ignored in folder collections unless the `path` option is configured to end with `_index` and the `extension` is `md`[^120]. You can still manage these files as part of a file collection if necessary.
|
|
255
|
-
-
|
|
256
|
-
- Entries can be listed and edited even if the collection doesn’t have the `title` field. In that case, an entry summary will be generated from a header in the Markdown `body` field, if exists, or from the entry slug. This supports a typical VitePress setup.
|
|
259
|
+
- A console error won’t be thrown when a collection doesn’t have the `title` field[^152]. In that case, an entry summary will be generated from a header in the Markdown `body` field, if exists, or from the entry slug, so the summary will never be an empty. This supports a typical VitePress setup.
|
|
257
260
|
- If there was an error while parsing an entry file, such as duplicate front matter keys, it won’t show up as a blank entry, and a clear error message will be displayed in the browser console[^121].
|
|
258
|
-
-
|
|
259
|
-
- The entry list supports basic Markdown formatting syntax in the titles: bold, italic and code are allowed. HTML character references (entities) are also parsed properly[^69].
|
|
261
|
+
- In an entry summary, basic Markdown syntax used in the title, including bold, italic and code, are parsed as Markdown. HTML character references (entities) are also parsed properly[^69].
|
|
260
262
|
- If you update an entry field that appears in the collection’s `summary`, such as `title`, the entry list displays an updated summary after you save the entry.
|
|
261
263
|
- If entries don’t have an Image field for thumbnails, the entry list will only be displayed in list view, because it doesn’t make sense to show grid view[^143].
|
|
262
264
|
- Assets stored in a [collection media folder](#using-a-custom-media-folder-for-a-collection) can be displayed next to the entries.
|
|
@@ -355,7 +357,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
355
357
|
- If the `public_folder` contains `{{slug}}` and you’ve edited a slug field (e.g. `title`) of a new entry after uploading an asset, the updated slug will be used in the saved asset path[^140]. Other dynamic template tags such as `{{filename}}` will also be populated as expected[^141].
|
|
356
358
|
- List and Object
|
|
357
359
|
- The `summary` is displayed correctly when it refers to a Relation field[^36] or a simple List field.
|
|
358
|
-
- The `summary` template tags support [
|
|
360
|
+
- The `summary` template tags support [transformations](https://decapcms.org/docs/summary-strings/), e.g. `{{fields.date | date('YYYY-MM-DD')}}`.
|
|
359
361
|
- Markdown, String and Text
|
|
360
362
|
- A required field containing only spaces or line breaks will result in a validation error, as if no characters were entered.
|
|
361
363
|
- Relation and Select
|
|
@@ -389,6 +391,7 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
389
391
|
- Upload multiple assets at once, including files in nested folders, by browsing or dragging and dropping them into the library[^5].
|
|
390
392
|
- Sort or filter assets by name or file type.
|
|
391
393
|
- View asset details, including size, dimensions, commit author/date and a list of entries that use the selected asset.
|
|
394
|
+
- The global `media_folder` can be an empty string (or `.` or `/`) if you want to store assets in the root folder.
|
|
392
395
|
- PDF documents are displayed with a thumbnail image in both the Asset Library and the Select File dialog, making it easier to find the file you’re looking for[^38].
|
|
393
396
|
- Assets stored in an entry-relative media folder are displayed in the Asset Library[^142].
|
|
394
397
|
- These entry-relative assets are automatically deleted when the associated entry is deleted because these are not available for other entries[^22]. When you’re [working with a local repository](#working-with-a-local-git-repository), the empty enclosing folder is also deleted.
|
|
@@ -396,7 +399,6 @@ Sveltia CMS has been built with a multilingual architecture from the very beginn
|
|
|
396
399
|
- Users can add assets using the Quick Add button in the upper right corner of the application.
|
|
397
400
|
- Files are uploaded with their original names, without converting uppercase letters and spaces to lowercase letters and hyphens[^97].
|
|
398
401
|
- No fatal application crash when uploading assets[^112].
|
|
399
|
-
- `media_folder` can be an empty string (or `.` or `/`) if you want to store assets in the root folder.
|
|
400
402
|
|
|
401
403
|
### Better customization
|
|
402
404
|
|
|
@@ -433,22 +435,22 @@ These limitations are expected to be resolved before or shortly after GA:
|
|
|
433
435
|
|
|
434
436
|
| Feature | Status in Sveltia CMS |
|
|
435
437
|
| --- | --- |
|
|
436
|
-
| Backends | The Test backend needed for our demo site is not yet added. We’ll see if Azure DevOps can also be supported. |
|
|
438
|
+
| Backends | The [Test](https://decapcms.org/docs/test-backend/) backend needed for our demo site is not yet added. We’ll see if [Azure DevOps](https://decapcms.org/docs/azure-backend/) can also be supported. |
|
|
437
439
|
| Configuration | Comprehensive config validation is not yet implemented. |
|
|
438
440
|
| Localization | The application UI is only available in English and Japanese at this time. |
|
|
439
|
-
| Media Libraries | Cloudinary and Uploadcare are not yet supported. |
|
|
440
|
-
| Workflow | Editorial Workflow and Open Authoring are not yet supported and will be implemented after the 1.0 release. |
|
|
441
|
-
| Collections | Nested Collections (beta) are not yet supported and will be implemented after the 1.0 release. |
|
|
442
|
-
| Widgets | Custom widgets are not yet supported. See the table below for other limitations. |
|
|
443
|
-
| Customizations | Custom previews and event subscriptions are not yet supported. |
|
|
441
|
+
| Media Libraries | [Cloudinary](https://decapcms.org/docs/cloudinary/) and [Uploadcare](https://decapcms.org/docs/uploadcare/) are not yet supported. |
|
|
442
|
+
| Workflow | [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/) and [Open Authoring](https://decapcms.org/docs/open-authoring/) are not yet supported and will be implemented after the 1.0 release. |
|
|
443
|
+
| Collections | [Nested Collections](https://decapcms.org/docs/collection-nested/) (beta) are not yet supported and will be implemented after the 1.0 release. |
|
|
444
|
+
| Widgets | [Custom widgets](https://decapcms.org/docs/custom-widgets/) are not yet supported. See the table below for other limitations. |
|
|
445
|
+
| Customizations | [Custom previews](https://decapcms.org/docs/customization/) and [event subscriptions](https://decapcms.org/docs/registering-events/) are not yet supported. |
|
|
444
446
|
|
|
445
447
|
| Widget | Status in Sveltia CMS |
|
|
446
448
|
| --- | --- |
|
|
447
|
-
| Code | Not yet supported. |
|
|
448
|
-
| DateTime | The `date_format` and `time_format` options with Moment.js tokens are not yet supported. Note that [Decap CMS 3.1.1](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.1.1) replaced Moment.js 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 other changes to the widget behaviour; we’ll follow these changes where it makes sense. |
|
|
449
|
-
| File/Image | Field-specific media folders and media library options are not yet supported other than `media_library.config.max_file_size` for the default media library. |
|
|
450
|
-
| Map | Not yet supported. |
|
|
451
|
-
| Markdown | Editor components, including built-in `image` and `code-block` as well as custom components, are not yet supported. |
|
|
449
|
+
| [Code](https://decapcms.org/docs/widgets/#code) | Not yet supported. |
|
|
450
|
+
| [DateTime](https://decapcms.org/docs/widgets/#datetime) | The `date_format` and `time_format` options with Moment.js tokens are not yet supported. Note that [Decap CMS 3.1.1](https://github.com/decaporg/decap-cms/releases/tag/decap-cms%403.1.1) replaced Moment.js 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 other changes to the widget behaviour; we’ll follow these changes where it makes sense. |
|
|
451
|
+
| [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. |
|
|
452
|
+
| [Map](https://decapcms.org/docs/widgets/#map) | Not yet supported. |
|
|
453
|
+
| [Markdown](https://decapcms.org/docs/widgets/#markdown) | Editor components, including built-in `image` and `code-block` as well as custom components, are not yet supported. |
|
|
452
454
|
|
|
453
455
|
### Other notes
|
|
454
456
|
|
|
@@ -1260,3 +1262,7 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
1260
1262
|
[^149]: Netlify/Decap CMS [#13](https://github.com/decaporg/decap-cms/issues/13) — The issue appears to have been closed without a fix being available.
|
|
1261
1263
|
|
|
1262
1264
|
[^150]: Netlify/Decap CMS [#7319](https://github.com/decaporg/decap-cms/issues/7319)
|
|
1265
|
+
|
|
1266
|
+
[^151]: Netlify/Decap CMS [#7328](https://github.com/decaporg/decap-cms/issues/7328)
|
|
1267
|
+
|
|
1268
|
+
[^152]: Netlify/Decap CMS [#2491](https://github.com/decaporg/decap-cms/issues/2491)
|