@sveltia/cms 0.6.1 → 0.6.2
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 +20 -12
- package/dist/sveltia-cms.js +231 -231
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -12,6 +12,10 @@ Sveltia CMS is a Git-based lightweight headless CMS under development as a drop-
|
|
|
12
12
|
|
|
13
13
|
<br>
|
|
14
14
|
|
|
15
|
+
## Motivation
|
|
16
|
+
|
|
17
|
+
Sveltia CMS was born in November 2022, when the development of Netlify CMS had been at a standstill for more than half a year. [@kyoshino](https://github.com/kyoshino)’s clients wanted to replace their Netlify CMS instances mainly to get better internationalization support. Sveltia CMS was built from the ground up to take i18n into account in every corner of the product, while also striving for better UX, performance and productivity. Another goal of the project is to showcase the power of [Svelte](https://svelte.dev/), a modern UI library for creating web applications with less code.
|
|
18
|
+
|
|
15
19
|
## Features
|
|
16
20
|
|
|
17
21
|
Sveltia CMS is a Git-based lightweight headless CMS, which means:
|
|
@@ -36,17 +40,15 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
|
|
|
36
40
|
|
|
37
41
|
### Better performance
|
|
38
42
|
|
|
39
|
-
- Built completely from scratch with
|
|
40
|
-
- Using the GraphQL API for GitHub by default to fetch contents quickly at once, so showing and searching entries and media are
|
|
43
|
+
- Built completely from scratch with Svelte rather than 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.
|
|
44
|
+
- Using the GraphQL API for GitHub by default to fetch contents quickly at once, so showing and searching entries and media are instant. Saving entries and media is also much faster.
|
|
41
45
|
- Caching Git files locally to speed up startup and reduce bandwidth.
|
|
42
46
|
- Small footprint: less than 300 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS. And [no virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
|
|
43
47
|
|
|
44
48
|
### Better productivity
|
|
45
49
|
|
|
46
|
-
- Required fields, not optional fields, are clearly marked for efficient data entry.
|
|
47
|
-
- Integration with Pexels, Pixabay and Unsplash makes it easy to insert free stock photos into image fields[^8].
|
|
48
50
|
- You can [work on a local Git repository](#work-with-a-local-git-repository) without having to run a proxy server.
|
|
49
|
-
-
|
|
51
|
+
- You can delete multiple entries and assets at once.
|
|
50
52
|
- Providing some keyboard shortcuts for faster editing. More to come!
|
|
51
53
|
- Create a new entry: `Ctrl+E` (Windows/Linux) / `Command+E` (macOS)
|
|
52
54
|
- Save an entry: `Ctrl+S` (Windows/Linux) / `Command+S` (macOS)
|
|
@@ -56,24 +58,29 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
|
|
|
56
58
|
### Better i18n support
|
|
57
59
|
|
|
58
60
|
- Making it easier to switch between locales while editing with just a click on a button.
|
|
61
|
+
- Fields in non-default locales will be validated as expected[^13]
|
|
59
62
|
- [Integrating DeepL](#use-deepl-to-translate-entry-fields) to allow translating text fields from another locale with one click.
|
|
60
|
-
- You can
|
|
63
|
+
- 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 writing in non-Latin characters[^12].
|
|
61
64
|
- Solving limitations in Netlify/Decap CMS’s [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].
|
|
62
|
-
- Users can now choose their preferred UI locale.
|
|
63
65
|
|
|
64
66
|
### Collection enhancements
|
|
65
67
|
|
|
66
68
|
- You can choose a [custom icon for each collection](#use-a-custom-icon-for-a-collection)[^3].
|
|
67
|
-
- A [per-collection media folder](#use-a-custom-media-folder-for-a-collection) will
|
|
69
|
+
- A [per-collection media folder](#use-a-custom-media-folder-for-a-collection) will appear aside of entries.
|
|
68
70
|
- String values in YAML files can be quoted with the new `yaml_quote: true` option for a collection, mainly for framework compatibility[^9].
|
|
69
71
|
|
|
72
|
+
### Field enhancements
|
|
73
|
+
|
|
74
|
+
- Required fields, not optional fields, are clearly marked for efficient data entry.
|
|
75
|
+
- Integration with Pexels, Pixabay and Unsplash makes it easy to insert free stock photos into image fields[^8].
|
|
76
|
+
- You can revert changes for all fields or a specific field/object/list.
|
|
77
|
+
|
|
70
78
|
### Media library enhancements
|
|
71
79
|
|
|
72
80
|
- An all-new media library makes it easy to manage all your assets.
|
|
73
|
-
-
|
|
74
|
-
-
|
|
75
|
-
-
|
|
76
|
-
- You can now navigate between the global media folder and a per-collection media folder[^6].
|
|
81
|
+
- You can sort or filter assets by name or file type and view asset details, including size, dimensions, and a list of entries that use the selected asset.
|
|
82
|
+
- You can upload multiple assets at once, including files in nested folders, by browsing or dragging & dropping them into the media library[^5].
|
|
83
|
+
- You can navigate between the global media folder and a per-collection media folder[^6].
|
|
77
84
|
|
|
78
85
|
## Compatibility
|
|
79
86
|
|
|
@@ -351,3 +358,4 @@ This software is provided “as is” without any express or implied warranty. T
|
|
|
351
358
|
[^10]: [Netlify/Decap CMS #341](https://github.com/decaporg/decap-cms/issues/341)
|
|
352
359
|
[^11]: [Netlify/Decap CMS #1382](https://github.com/decaporg/decap-cms/issues/1382) and many more. We’ll be updating this list after reviewing their issue list.
|
|
353
360
|
[^12]: [Netlify/Decap CMS #1975](https://github.com/decaporg/decap-cms/issues/1975)
|
|
361
|
+
[^13]: [Netlify/Decap CMS #5112](https://github.com/decaporg/decap-cms/issues/5112)
|