@sveltia/cms 0.91.0 → 0.91.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 +30 -14
- package/dist/sveltia-cms.js +207 -207
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +208 -208
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -133,7 +133,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
|
|
|
133
133
|
|
|
134
134
|
- Ensuring substantial [compatibility with Netlify/Decap CMS](#compatibility)
|
|
135
135
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
136
|
-
- So far, 235+ issues, or
|
|
136
|
+
- So far, 235+ issues, or 485+ if including duplicates, have been effectively solved in Sveltia CMS (Yes, you read it right)
|
|
137
137
|
- Target:
|
|
138
138
|
- 250 issues, or 500 if including duplicates, by GA — Almost there!
|
|
139
139
|
- 400 issues, or 800 if including duplicates, in the future 💪
|
|
@@ -244,7 +244,7 @@ Note: This lengthy section compares Sveltia CMS with both Netlify CMS and Decap
|
|
|
244
244
|
|
|
245
245
|
The [GitHub](https://decapcms.org/docs/github-backend/), [GitLab](https://decapcms.org/docs/gitlab-backend/), [Gitea/Forgejo](https://decapcms.org/docs/gitea-backend/) and [Test](https://decapcms.org/docs/test-backend/) backends are available in Sveltia CMS. For [performance reasons](#features-not-to-be-implemented), we don’t support [Azure](https://decapcms.org/docs/azure-backend/), [Bitbucket](https://decapcms.org/docs/bitbucket-backend/) and [Git Gateway](https://decapcms.org/docs/git-gateway-backend/).
|
|
246
246
|
|
|
247
|
-
- Uses the GraphQL API where possible for better performance, as mentioned above. You don’t need to set the `use_graphql` option to enable it for GitHub and GitLab.
|
|
247
|
+
- Uses the GraphQL API where possible for better performance, as mentioned above. You don’t need to set the `use_graphql` option to enable it for GitHub and GitLab.[^65]
|
|
248
248
|
- The Git branch name is automatically set to the repository’s default branch (`main`, `master` or whatever) if not specified in the configuration file, preventing data loading errors due to a hardcoded fallback to `master`.[^95][^27] If a branch name is specified, it works as expected.[^232]
|
|
249
249
|
- It’s possible to [disable automatic deployments](#disabling-automatic-deployments) by default or on demand to save costs and resources associated with CI/CD and to publish multiple changes at once.[^24]
|
|
250
250
|
- The GitLab backend support comes with background [service status](https://status.gitlab.com/) checking, just like GitHub.
|
|
@@ -254,7 +254,7 @@ The [GitHub](https://decapcms.org/docs/github-backend/), [GitLab](https://decapc
|
|
|
254
254
|
- The GitLab backend supports Git LFS ([documentation](https://docs.gitlab.com/topics/git/lfs/)).[^231]
|
|
255
255
|
- Users won’t get a 404 Not Found error when you sign in to the GitLab backend.[^115]
|
|
256
256
|
- Our Gitea/Forgejo backend is high-performing because it retrieves multiple entries at once. It also supports Git LFS ([documentation](https://docs.gitea.com/administration/git-lfs-setup)). Additionally, the backend won’t cause 400 Bad Request errors due to the presence of `DRAFT_MEDIA_FILES` in file paths.[^222]
|
|
257
|
-
- Users can sign in directly with Git
|
|
257
|
+
- Users can sign in directly with a Git-based backend using a personal access token (PAT) instead of going through the regular OAuth flow.[^258] To do so, click the small arrow button next to the Sign In button, and select Use Personal Access Token.
|
|
258
258
|
- The OAuth access token is automatically renewed when using the GitLab or Gitea/Forgejo backend with PKCE authorization.[^224] Token renewal for other backend configurations will be implemented later.
|
|
259
259
|
- Features the all-new [local repository workflow](#working-with-a-local-git-repository) that boosts DX. See the [productivity section](#better-productivity) above.
|
|
260
260
|
- Developers can select the local and remote backends while working on a local server.
|
|
@@ -468,6 +468,7 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
|
|
|
468
468
|
- An optional Object field (`required: false`) can be manually added or removed with a checkbox.[^88] If unadded or removed, the required subfields won’t trigger validation errors,[^16] and the field will be saved as `null`.
|
|
469
469
|
- Relation
|
|
470
470
|
- Field options are displayed with no additional API requests.[^14] The confusing `options_length` option, which defaults to 20, is therefore ignored.[^76]
|
|
471
|
+
- The widget reliably displays the selected option in the summary and all available options in the dropdown list.[^259]
|
|
471
472
|
- `slug` can be used for `value_field` to show all available options instead of just one in some situations.[^91]
|
|
472
473
|
- Template strings with a wildcard like `{{cities.*.name}}` can also be used for `value_field`.[^94]
|
|
473
474
|
- `display_fields` is displayed in the Preview Pane instead of `value_field`.
|
|
@@ -611,7 +612,6 @@ These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are
|
|
|
611
612
|
- Comprehensive site config validation
|
|
612
613
|
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) other than English and Japanese
|
|
613
614
|
- [Cloudinary](https://decapcms.org/docs/cloudinary/) and [Uploadcare](https://decapcms.org/docs/uploadcare/) media libraries ([#4](https://github.com/sveltia/sveltia-cms/discussions/4))
|
|
614
|
-
- Field-specific media folders (beta) for the [File](https://decapcms.org/docs/widgets/#file) and [Image](https://decapcms.org/docs/widgets/#image) widgets
|
|
615
615
|
- LineString and Polygon types for the [Map](https://decapcms.org/docs/widgets/#map) widget
|
|
616
616
|
- [Custom widgets](https://decapcms.org/docs/custom-widgets/)
|
|
617
617
|
- [Custom editor components](https://decapcms.org/docs/custom-widgets/#registereditorcomponent): Support for preview, Object/List widgets, and the `default` field option
|
|
@@ -623,6 +623,7 @@ Due to the complexity, we have decided to defer the following features to the 2.
|
|
|
623
623
|
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/) with [deploy preview links](https://decapcms.org/docs/deploy-preview-links/)
|
|
624
624
|
- [Open authoring](https://decapcms.org/docs/open-authoring/)
|
|
625
625
|
- [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
|
|
626
|
+
- Field-specific media folders (beta) for the [File](https://decapcms.org/docs/widgets/#file) and [Image](https://decapcms.org/docs/widgets/#image) widgets
|
|
626
627
|
|
|
627
628
|
Found a compatibility issue or other missing feature? [Let us know](https://github.com/sveltia/sveltia-cms/issues/new?type=bug). Bear in mind that undocumented behaviour can easily be overlooked.
|
|
628
629
|
|
|
@@ -756,6 +757,8 @@ If you’ve chosen to install with npm, updating the package is your responsibil
|
|
|
756
757
|
|
|
757
758
|
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 or GitLab 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.
|
|
758
759
|
|
|
760
|
+
You can also generate a personal access token (PAT) on GitHub or GitLab, and use it to sign in. No OAuth client is needed. While this method is convenient for developers, it’s better to set up an OAuth client if your CMS instance is used by non-technical users because it’s more user-friendly and secure.
|
|
761
|
+
|
|
759
762
|
### Enabling autocomplete and validation for the configuration file
|
|
760
763
|
|
|
761
764
|
Sveltia CMS provides a full [JSON schema](https://json-schema.org/) for the configuration file, so you can get autocomplete and validation in your favourite code editor while editing the site configuration. The schema is generated from the source and always up to date with the latest CMS version.
|
|
@@ -1532,9 +1535,9 @@ Due late 2025
|
|
|
1532
1535
|
|
|
1533
1536
|
- Enhanced [compatibility with Netlify/Decap CMS](#current-limitations)
|
|
1534
1537
|
- Tackling some more Netlify/Decap CMS issues:
|
|
1535
|
-
- [Directory navigation in the Asset Library](https://github.com/sveltia/sveltia-cms/issues/420)[^240]
|
|
1536
|
-
- [Multiple file selection with the File and Image widgets](https://github.com/sveltia/sveltia-cms/issues/10)[^239]
|
|
1537
|
-
- [Git LFS support for the GitHub backend](https://github.com/sveltia/sveltia-cms/discussions/353)[^244]
|
|
1538
|
+
- [Directory navigation in the Asset Library](https://github.com/sveltia/sveltia-cms/issues/420)[^240]
|
|
1539
|
+
- [Multiple file selection with the File and Image widgets](https://github.com/sveltia/sveltia-cms/issues/10)[^239]
|
|
1540
|
+
- [Git LFS support for the GitHub backend](https://github.com/sveltia/sveltia-cms/discussions/353)[^244]
|
|
1538
1541
|
- Advanced Relation fields[^242], including cascade updates/deletes[^243] and [reverse reference lists](https://github.com/sveltia/sveltia-cms/discussions/416)
|
|
1539
1542
|
- Several Cloudinary and Uploadcare media library issues, including selection of existing files[^247]
|
|
1540
1543
|
- [Automatic asset file renaming with templates](https://github.com/sveltia/sveltia-cms/issues/422)[^241]
|
|
@@ -1542,6 +1545,7 @@ Due late 2025
|
|
|
1542
1545
|
- Thorough site config validation[^246]
|
|
1543
1546
|
- [Entry pre-validation/normalization](https://github.com/sveltia/sveltia-cms/issues/395)[^248]
|
|
1544
1547
|
- and a few more bugs
|
|
1548
|
+
- Migration from Moment.js to Day.js
|
|
1545
1549
|
- Accessibility audit
|
|
1546
1550
|
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md)
|
|
1547
1551
|
- Developer documentation (implementation guide)
|
|
@@ -1552,16 +1556,26 @@ Due late 2025
|
|
|
1552
1556
|
|
|
1553
1557
|
Due early 2026
|
|
1554
1558
|
|
|
1555
|
-
- Implementing [a few deferred Netlify/Decap CMS features](#current-limitations)
|
|
1556
|
-
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/) with [deploy preview links](https://decapcms.org/docs/deploy-preview-links/)
|
|
1557
|
-
- [Open authoring](https://decapcms.org/docs/open-authoring/)
|
|
1558
|
-
- [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
|
|
1559
|
+
- Implementing [a few deferred Netlify/Decap CMS features](#current-limitations), including editorial workflow and nested collections
|
|
1559
1560
|
- End-user documentation
|
|
1560
1561
|
|
|
1561
1562
|
### Future
|
|
1562
1563
|
|
|
1563
|
-
- Tackling many of the remaining Netlify/Decap CMS issues, including
|
|
1564
|
-
-
|
|
1564
|
+
- Tackling many of the remaining Netlify/Decap CMS issues, including:
|
|
1565
|
+
- MDX support[^122]
|
|
1566
|
+
- [Manual entry sorting](https://github.com/sveltia/sveltia-cms/issues/214)[^125]
|
|
1567
|
+
- [Tables in Markdown](https://github.com/sveltia/sveltia-cms/issues/455)[^256]
|
|
1568
|
+
- [Config editor](https://github.com/sveltia/sveltia-cms/discussions/452)[^10]
|
|
1569
|
+
- Offline support[^238]
|
|
1570
|
+
- and other [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
1571
|
+
- (some of them may be included in v2.0)
|
|
1572
|
+
- **Sveltia CMS Additions**: edge functions providing features that cannot be implemented client-side:
|
|
1573
|
+
- User management (Netlify Identity alternative) with roles[^23]
|
|
1574
|
+
- Sign-in without a Git service account (Git Gateway alternative)
|
|
1575
|
+
- Post locking (like [WordPress](https://codex.wordpress.org/Post_Locking))[^166]
|
|
1576
|
+
- Scheduled posts[^167]
|
|
1577
|
+
- Credential management for service API keys, deploy hook URL, etc.
|
|
1578
|
+
- [Preact+HTM support](https://github.com/sveltia/sveltia-cms/discussions/153) for custom widgets, editor components and preview templates
|
|
1565
1579
|
- View, compare and restore revisions (like [WordPress](https://wordpress.com/support/page-post-revisions/))
|
|
1566
1580
|
- More integration options: stock photos, stock videos, cloud storage providers, translation services, maps, analytics tools, etc.
|
|
1567
1581
|
- AI integrations for image generation, content writing, translation, etc.
|
|
@@ -2104,4 +2118,6 @@ This software is provided “as is” without any express or implied warranty. W
|
|
|
2104
2118
|
|
|
2105
2119
|
[^257]: Netlify/Decap CMS [#4353](https://github.com/decaporg/decap-cms/issues/4353), [#7513](https://github.com/decaporg/decap-cms/issues/7513), [#7544](https://github.com/decaporg/decap-cms/issues/7544)
|
|
2106
2120
|
|
|
2107
|
-
[^258]: Netlify/Decap CMS [#663](https://github.com/decaporg/decap-cms/issues/663), [#7466](https://github.com/decaporg/decap-cms/discussions/7466), [#7545](https://github.com/decaporg/decap-cms/issues/7545)
|
|
2121
|
+
[^258]: Netlify/Decap CMS [#663](https://github.com/decaporg/decap-cms/issues/663), [#6729](https://github.com/decaporg/decap-cms/discussions/6729), [#7466](https://github.com/decaporg/decap-cms/discussions/7466), [#7545](https://github.com/decaporg/decap-cms/issues/7545)
|
|
2122
|
+
|
|
2123
|
+
[^259]: Netlify/Decap CMS [#7546](https://github.com/decaporg/decap-cms/issues/7546)
|