@sveltia/cms 0.21.5 → 0.22.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 CHANGED
@@ -119,6 +119,7 @@ We are working hard to create a **significantly better alternative to Netlify CM
119
119
 
120
120
  ### Better collections
121
121
 
122
+ - Supports a [JSON configuration file](#providing-a-json-configuration-file) that can be generated for bulk or complex collections[^60].
122
123
  - You can choose a [custom icon for each collection](#using-a-custom-icon-for-a-collection)[^3].
123
124
  - Assets stored in a [per-collection media folder](#using-a-custom-media-folder-for-a-collection) can be displayed next to the entries.
124
125
  - Entry slug template tags support [filter transformations](https://decapcms.org/docs/summary-strings/) just like summary string template tags[^29].
@@ -217,7 +218,7 @@ The table below shows the current limitations of Sveltia CMS, that are expected
217
218
  | Feature | Status in Sveltia CMS |
218
219
  | --- | --- |
219
220
  | Backends | Only GitHub and GitLab are available. We’ll add the Test backend for our demo site and see if Azure can also be supported. |
220
- | Configuration | UI Locales are only available in English and Japanese. Comprehensive config validation is not yet implemented. |
221
+ | Configuration | The application UI locales are only available in English and Japanese. Comprehensive config validation is not yet implemented. |
221
222
  | Media Libraries | Cloudinary and Uploadcare are not yet supported. |
222
223
  | Workflow | Editorial Workflow and Open Authoring are not yet supported. |
223
224
  | Content Editor | Auto-saving a draft entry is not yet implemented. |
@@ -310,6 +311,16 @@ If you’ve chosen to install with npm, updating the package is your responsibil
310
311
 
311
312
  ## Tips & tricks
312
313
 
314
+ ### Providing a JSON configuration file
315
+
316
+ Sveltia CMS supports a configuration file written in the JSON format in addition to the standard YAML format. This allows developers to programmatically generate the CMS configuration to enable bulk or complex collections. To do this, simply add a `<link>` tag to your HTML, just like a [custom YAML config link](https://decapcms.org/docs/configuration-options/#configuration-file), but with the type `application/json`:
317
+
318
+ ```html
319
+ <link href="path/to/config.json" type="application/json" rel="cms-config-url" />
320
+ ```
321
+
322
+ Alternatively, you can [manually initialize](https://decapcms.org/docs/manual-initialization/) the CMS with a JavaScript configuration object.
323
+
313
324
  ### Migrating from Git Gateway backend
314
325
 
315
326
  Sveltia CMS does not support the Git Gateway backend (and Netlify Identity) due to performance limitations. If you don’t care about user management, you can easily migrate to the [GitHub backend](https://decapcms.org/docs/github-backend/) or [GitLab backend](https://decapcms.org/docs/gitlab-backend/). Make sure **you install an OAuth client** on GitHub or GitLab in addition to updating your configuration file. As noted in the document, Netlify still facilitates the auth flow.
@@ -608,3 +619,4 @@ This software is provided “as is” without any express or implied warranty. W
608
619
  [^57]: Netlify/Decap CMS [#328](https://github.com/decaporg/decap-cms/issues/328), [#3853](https://github.com/decaporg/decap-cms/issues/3853)
609
620
  [^58]: Netlify/Decap CMS [#5125](https://github.com/decaporg/decap-cms/issues/5125)
610
621
  [^59]: Netlify/Decap CMS [#1654](https://github.com/decaporg/decap-cms/issues/1654)
622
+ [^60]: Netlify/Decap CMS [#386](https://github.com/decaporg/decap-cms/issues/386)