@sveltia/cms 0.1.6 → 0.1.8
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 +12 -8
- package/dist/sveltia-cms.js +115 -116
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Sveltia CMS
|
|
2
2
|
|
|
3
|
-
Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://
|
|
3
|
+
Sveltia CMS is a Git-based lightweight headless CMS partially compatible with [Netlify/Decap CMS](https://decapcms.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
5
|
<br>
|
|
6
6
|
|
|
@@ -19,7 +19,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
|
|
|
19
19
|
### Compatible with Netlify/Decap CMS
|
|
20
20
|
|
|
21
21
|
- Ready to replace Netlify/Decap CMS _in some casual use case scenarios_ by updating one single line of code.
|
|
22
|
-
- Existing [configuration files](https://
|
|
22
|
+
- Existing [configuration files](https://decapcms.org/docs/configuration-options/) can be reused as is.
|
|
23
23
|
- Many features are still missing though; [see the chart below](#compatibility) for details.
|
|
24
24
|
|
|
25
25
|
### Better UX
|
|
@@ -45,7 +45,7 @@ Here are some highlights mainly compared to Netlify/Decap CMS:
|
|
|
45
45
|
- Making it easier to switch between locales while editing.
|
|
46
46
|
- Integrating DeepL to allow translating text fields from another locale with one click. [See below](#use-deepl-to-translate-entry-fields) for details.
|
|
47
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.
|
|
48
|
-
- Solving limitations in Netlify/Decap CMS’s [list and object widgets](https://
|
|
48
|
+
- 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[^7].
|
|
49
49
|
- Users can now choose their preferred UI locale.
|
|
50
50
|
|
|
51
51
|
### Collection enhancements
|
|
@@ -66,7 +66,7 @@ While we’re not recreating all the features found in Netlify/Decap CMS, our pl
|
|
|
66
66
|
| Feature | Status in Sveltia CMS |
|
|
67
67
|
| --- | --- |
|
|
68
68
|
| UI locales | Only English and Japanese are available at this time. No registration is needed. It can be changed in Preferences. |
|
|
69
|
-
| Account | Only the GitHub backend is available at this time. You can
|
|
69
|
+
| Account | Only the 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 OAuth client](https://github.com/sveltia/sveltia-cms-auth)) 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. |
|
|
70
70
|
| Configuration | Supported. |
|
|
71
71
|
| Media | External media storage services are not yet supported. |
|
|
72
72
|
| Editorial Workflow | Coming soon. |
|
|
@@ -130,7 +130,7 @@ While we’re not recreating all the features found in Netlify/Decap CMS, our pl
|
|
|
130
130
|
|
|
131
131
|
### New users
|
|
132
132
|
|
|
133
|
-
Currently, Sveltia CMS is aimed at existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://
|
|
133
|
+
Currently, Sveltia CMS is aimed at existing Netlify/Decap CMS users. If you don’t have it yet, follow [their documentation](https://decapcms.org/docs/intro/) to install it and configure your site first. Then migrate to Sveltia CMS as described below.
|
|
134
134
|
|
|
135
135
|
### Migration
|
|
136
136
|
|
|
@@ -151,9 +151,13 @@ Sveltia CMS is still in early beta, so we do expect various bugs. Please [report
|
|
|
151
151
|
|
|
152
152
|
## Tips & tricks
|
|
153
153
|
|
|
154
|
+
### Move your site from Netlify to another hosting service
|
|
155
|
+
|
|
156
|
+
You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com/). But moving away from Netlify means you can no longer sign in with GitHub via Netlify. Instead, you can use [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth), which can be easily deployed to Cloudflare Workers, or [any other 3rd party client](https://decapcms.org/docs/external-oauth-clients/) made for Netlify/Decap CMS.
|
|
157
|
+
|
|
154
158
|
### Work with a local Git repository
|
|
155
159
|
|
|
156
|
-
You can use Sveltia CMS with a local Git repository, just like the [beta feature](https://
|
|
160
|
+
You can use Sveltia CMS with a local Git repository, just 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 necessity of the additional configuration and proxy server, thanks to the [File System Access API](https://developer.chrome.com/articles/file-system-access/).
|
|
157
161
|
|
|
158
162
|
1. Launch the local development server for your frontend framework, typically with `npm run dev`.
|
|
159
163
|
1. Visit `http://localhost:[port]/admin/index.html` with [Chrome or Edge](https://developer.mozilla.org/en-US/docs/web/api/window/showopenfilepicker#browser_compatibility).
|
|
@@ -183,7 +187,7 @@ As shown in the screenshot above, you can use different icons for collections in
|
|
|
183
187
|
|
|
184
188
|
### Use a custom media folder for a collection
|
|
185
189
|
|
|
186
|
-
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://
|
|
190
|
+
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.
|
|
187
191
|
|
|
188
192
|
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.
|
|
189
193
|
|
|
@@ -214,7 +218,7 @@ Sveltia CMS comes with a handy DeepL integration so that you can translate any t
|
|
|
214
218
|
|
|
215
219
|
### Use a random ID for an entry slug
|
|
216
220
|
|
|
217
|
-
By default, the [slug for a new entry file](https://
|
|
221
|
+
By default, the [slug for a new entry file](https://decapcms.org/docs/configuration-options/#slug) will be generated based on the entry’s title field. Or, you can specify the collection’s `slug` option to use the file creation date or other fields. While the behavior is generally acceptable and SEO-friendly, it’s not useful if the title might change later or if it contains non-Latin characters like Chinese. In Sveltia CMS, you can easily generate a random [UUID](https://developer.mozilla.org/en-US/docs/Glossary/UUID) without a custom widget!
|
|
218
222
|
|
|
219
223
|
It’s simple — just specify `{{uuid}}` (full UUID v4) or `{{uuid_short}}` (last 12 characters only) in the `slug` option. The results would look like `4fc0917c-8aea-4ad5-a476-392bdcf3b642` and `392bdcf3b642`, respectively.
|
|
220
224
|
|