Skip to content

Commit ecc34f5

Browse files
committed
Update README.md
1 parent cef0c49 commit ecc34f5

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ This free, open source successor to Netlify/Decap CMS is currently in public bet
4343
- [Better asset management](#better-asset-management)
4444
- [Better customization](#better-customization)
4545
- [Better localization](#better-localization)
46+
- [Better documentation](#better-documentation)
4647
- [Compatibility](#compatibility)
4748
- [Current limitations](#current-limitations)
4849
- [Features not to be implemented](#features-not-to-be-implemented)
@@ -292,7 +293,6 @@ We’ve made various improvements to help you get your work done faster and more
292293

293294
### Better configuration
294295

295-
- We provide comprehensive [compatibility information](#compatibility) to help you avoid unsupported options and configurations that might cause errors. By contrast, the Netlify/Decap CMS documentation does not mention the deprecation of camel case options, the removal of the Date widget and the replacement of Moment.js.
296296
- Sveltia CMS supports a [JSON configuration file](#providing-a-json-configuration-file) that can be generated for bulk or complex collections.[^60] A [TOML configuration file](#providing-a-toml-configuration-file) is also supported.
297297
- Also supports [multiple configuration files](#providing-multiple-configuration-files) to allow developers to modularize the configuration.[^197]
298298
- We provide an [up-to-date JSON schema](#enabling-autocomplete-and-validation-for-the-configuration-file) for YAML/JSON configuration files, which enables autocomplete and validation in VS Code and other editors.[^253] If you use [deprecated options](#deprecations) in a supported code editor, you should receive a warning.
@@ -624,6 +624,8 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
624624
- KeyValue (Dictionary)
625625
- The new `keyvalue` widget allows users to add arbitrary key-value string pairs to a field.[^123]
626626
- While the implementation is compatible with [Static CMS](https://staticjscms.netlify.app/docs/widget-keyvalue), we provide a more intuitive UI. You can press Enter to move focus or add a new row while editing, and the preview is displayed in a clean table.
627+
- RichText
628+
- Currently, the `richtext` widget is a simple alias of `markdown`. We plan to add HTML output support in the future.
627629
- UUID
628630
- In addition to [generating UUIDs for entry slugs](#using-a-random-id-for-an-entry-slug), Sveltia CMS supports the proposed `uuid` widget with the following properties:[^12]
629631
- `prefix`: A string to be prepended to the value. Default: an empty string.
@@ -683,6 +685,8 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
683685
- Enhancements to [event hooks](https://decapcms.org/docs/registering-events/):
684686
- Missing `identifier_field` won’t cause an error when the `preSave` hook is triggered.[^306]
685687
<!-- - Content can be modified in the `prePublish` hook (once we support editorial workflow).[^307] -->
688+
- Enhancements to custom field types (widgets):
689+
- The API method has been renamed from `CMS.registerWidget()` to `CMS.registerFieldType()` for better clarity, while keeping the old name for backward compatibility.[^314]
686690
- Async functions can be used for [custom parsers/formatters](https://decapcms.org/docs/custom-formatters/).[^149]
687691
- The application renders within the dimensions of a [custom mount element](https://decapcms.org/docs/custom-mounting/), if exists.[^109]
688692

@@ -693,6 +697,10 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
693697
- The List widget’s `label` and `label_singular` are not converted to lowercase, which is especially problematic in German, where all nouns are capitalized.[^98]
694698
- Long menu item labels, especially in non-English locales, don’t overflow the dropdown container.[^117][^265]
695699

700+
### Better documentation
701+
702+
- Our [compatibility information](#compatibility) to help you avoid unsupported options and configurations that might cause errors. By contrast, the Netlify/Decap CMS documentation does not mention anything about the deprecation of camel case options, the removal of the Date widget and the replacement of Moment.js. Furthermore, the [Decap blog](https://decapcms.org/blog/decap-3/) claims that Decap CMS 3.0 is ”fully backward compatible” even though it removed the Date widget.
703+
696704
## Compatibility
697705

698706
We are working to make Sveltia CMS compatible with Netlify/Decap CMS wherever possible so that more users can seamlessly switch to our modern successor. In some casual use cases, Sveltia CMS can be used as a drop-in replacement for Netlify/Decap CMS with [just a one-line code update](#migration).
@@ -2757,3 +2765,5 @@ This project would not have been possible without the open source Netlify CMS pr
27572765
[^312]: Netlify/Decap CMS [#1004](https://github.com/decaporg/decap-cms/issues/1004)
27582766

27592767
[^313]: Netlify/Decap CMS [#542](https://github.com/decaporg/decap-cms/issues/542)
2768+
2769+
[^314]: Netlify/Decap CMS [#3719](https://github.com/decaporg/decap-cms/issues/3719)

0 commit comments

Comments
 (0)