@sveltia/cms 0.1.3 → 0.1.5

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 (3) hide show
  1. package/README.md +22 -11
  2. package/dist/sveltia-cms.js +137 -137
  3. package/package.json +19 -16
package/README.md CHANGED
@@ -2,6 +2,16 @@
2
2
 
3
3
  Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://www.netlifycms.org/). You can use it with any static site generator, such as SvelteKit, Next.js and Hugo, if the content is managed on a Git repository. The product is now in public beta, with more features to come.
4
4
 
5
+ ![Screenshot: Git-based Headless CMS with Dark Mode](docs/screenshot-1.jpg)<br>
6
+
7
+ ![Screenshot: Instant Entry Listing, Searching and Saving](docs/screenshot-2.jpg)<br>
8
+
9
+ ![Screenshot: All-New Media Library](docs/screenshot-3.jpg)<br>
10
+
11
+ ![Screenshot: Stock Photo Integrations; Quick Translation](docs/screenshot-4.jpg)<br>
12
+
13
+ ![Screenshot: Single-Line Migration from Netlify/Decap CMS; Sveltia CMS](docs/screenshot-5.jpg)<br>
14
+
5
15
  ## Features
6
16
 
7
17
  Here are some highlights mainly compared to Netlify/Decap CMS:
@@ -10,23 +20,23 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
10
20
 
11
21
  - Ready to replace Netlify/Decap CMS _in some casual use case scenarios_ by updating one single line of code.
12
22
  - Existing [configuration files](https://www.netlifycms.org/docs/configuration-options/) can be reused as is.
13
- - Many features are still missing though; see the chart below for details.
23
+ - Many features are still missing though; [see the chart below](#compatibility) for details.
14
24
 
15
25
  ### Better UX
16
26
 
17
- - A modern, intuitive UI powered by the [Sveitia UI component library](https://github.com/sveltia/sveltia-ui), with some inspiration from the Netlify/Decap CMS v3 prototype[^1].
27
+ - Offering a modern, intuitive UI, with some inspiration from the Netlify/Decap CMS v3 prototype[^1].
18
28
  - Immersive dark mode[^2].
19
29
 
20
30
  ### Better performance
21
31
 
22
- - Built completely from scratch with [Svelte](https://svelte.dev/). The app starts fast and stays fast.
23
- - Using the GraphQL API for GitHub by default to fetch contents quickly at once, so showing and searching entries and media are now instant. Saving entries and media is also faster.
32
+ - Built completely from scratch with [Svelte](https://svelte.dev/) rather than forking React-based Netlify/Decap CMS. The app starts fast and stays fast.
33
+ - Using the GraphQL API for GitHub by default to fetch contents quickly at once, so showing and searching entries and media are now instant. Saving entries and media is also much faster.
24
34
  - Small footprint: less than 250 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS.
25
35
 
26
36
  ### Better productivity
27
37
 
28
38
  - Integrating Pexels, Pixabay and Unsplash to allow inserting free stock photos into image fields with no hassle.
29
- - Able to work on a local Git repository without installing a proxy server. [See below](#work-with-a-local-git-repository) for details.
39
+ - Able to work on a local Git repository without having to run a proxy server. [See below](#work-with-a-local-git-repository) for details.
30
40
  - Able to delete multiple entries and assets at once.
31
41
  - Solving various outstanding Netlify/Decap CMS bugs[^11].
32
42
 
@@ -36,7 +46,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
36
46
  - Integrating DeepL to allow translating text fields from another locale with one click. [See below](#use-deepl-to-translate-entry-fields) for details.
37
47
  - You can now use a random ID for an entry slug, which is a good option for locales writing in non-Latin characters. [See below](#use-a-random-id-for-an-entry-slug) for details.
38
48
  - Solving limitations in Netlify/Decap CMS’s [list and object widgets](https://www.netlifycms.org/docs/beta-features/#i18n-support) so that changes made with these widgets will be duplicated between locales as expected[^7].
39
- - Users can now choose their preferred UI locale. English and Japanese only at this time.
49
+ - Users can now choose their preferred UI locale.
40
50
 
41
51
  ### Collection enhancements
42
52
 
@@ -51,12 +61,12 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
51
61
 
52
62
  ## Compatibility
53
63
 
54
- While we’re not recreating all the features found in Netlify/Decap CMS, we plan to gradually expand the compatible areas where possible so that more users can migrate to our alternative.
64
+ While we’re not recreating all the features found in Netlify/Decap CMS, our plan is to gradually expand the compatible areas where possible so that more users can migrate to our alternative.
55
65
 
56
66
  | Feature | Status in Sveltia CMS |
57
67
  | --- | --- |
58
68
  | UI locales | Only English and Japanese are available at this time. No registration is needed. It can be changed in Preferences. |
59
- | Account | Only the GitHub backend is available at this time. You can use Netlify Identity or an external OAuth client to sign in with GitHub, just like Netlify/Decap CMS. GitLab could be supported later, but other backends are unlikely to be added, mainly due to the lack of GraphQL API. |
69
+ | Account | Only the GitHub backend is available at this time. You can use Netlify Identity or an external OAuth client to sign in with GitHub, just like Netlify/Decap CMS. GitLab could be supported later, but other backends are unlikely to be added, mainly due to the lack of an API method fetching contents in bulk. We’ll support the `test-repo` backend for a demo site. |
60
70
  | Configuration | Supported. |
61
71
  | Media | External media storage services are not yet supported. |
62
72
  | Editorial Workflow | Coming soon. |
@@ -70,8 +80,8 @@ While we’re not recreating all the features found in Netlify/Decap CMS, we pla
70
80
  | Widget | Status in Sveltia CMS |
71
81
  | --- | --- |
72
82
  | Code | Not yet supported. |
73
- | Color | It’s a native `<input>` widget at this time. The `enableAlpha` option is not yet supported. |
74
- | Date/DateTime | It’s also a native `<input>` widget. The `date_format` and `time_format` options with Moment.js tokens are not yet supported. We may deprecate the Moment.js format support anyway. |
83
+ | Color | It’s a native `<input>` element at this time. The `enableAlpha` option is not yet supported. |
84
+ | Date/DateTime | It’s also a native `<input>` element. The `date_format` and `time_format` options with Moment.js tokens are not yet supported. We may deprecate the Moment.js format support anyway. |
75
85
  | File/Image | The `media_library` options are not yet supported other than `max_file_size` and `choose_url`. |
76
86
  | List/Object | We haven’t tested with deeply nested fields. |
77
87
  | Map | Not yet supported. |
@@ -113,6 +123,7 @@ While we’re not recreating all the features found in Netlify/Decap CMS, we pla
113
123
  - Further Netlify/Decap CMS compatibility, including Editorial Workflow
114
124
  - Config editor[^10]
115
125
  - Documentation
126
+ - Demo site
116
127
  - Starter templates
117
128
 
118
129
  ## Getting started
@@ -278,4 +289,4 @@ This software is provided “as is” without any express or implied warranty. T
278
289
  [^6]: [Netlify/Decap CMS #3240](https://github.com/netlify/netlify-cms/issues/3240)
279
290
  [^7]: [Netlify/Decap CMS #4386](https://github.com/netlify/netlify-cms/issues/4386)
280
291
  [^10]: [Netlify/Decap CMS #341](https://github.com/netlify/netlify-cms/issues/341)
281
- [^11]: [Netlify/Decap CMS #1382](https://github.com/netlify/netlify-cms/issues/1382)
292
+ [^11]: [Netlify/Decap CMS #1382](https://github.com/netlify/netlify-cms/issues/1382) and many more. We’ll be updating this list after reviewing their issue list.