@sveltia/cms 0.87.2 → 0.87.4

package/types/public.d.ts

@@ -1,12 +1,14 @@
 /**
- * Standard IETF locale tag like `en` or `en-US`.
+ * Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_tag) like `en` or `en-US`.
  */
 export type LocaleCode = string;
 /**
  * An entry field name. It can be written in dot notation like `author.name` if the field is nested
- * with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We
- * call this a key path, which is derived from the IndexedDB API terminology, and use it everywhere,
- * as entry data is managed as a flatten object for easier access.
+ * with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call
+ * this a key path, which is derived from the [IndexedDB API
+ * terminology](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path),
+ * and use it everywhere, as entry data is managed as a [flatten
+ * object](https://www.npmjs.com/package/flat) for easier access.
  */
 export type FieldKeyPath = string;
 /**
@@ -28,7 +30,8 @@ export type VectorImageFormat = "svg";
  */
 export type RasterImageConversionFormat = "webp";
 /**
- * Raster image transformation options.
+ * Raster image transformation options. See our
+ * [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.
  */
 export type RasterImageTransformationOptions = {
     /**
@@ -36,7 +39,7 @@ export type RasterImageTransformationOptions = {
      */
     format?: RasterImageConversionFormat;
     /**
-     * Image quality between 0 and 100. Default: 85.
+     * Image quality between 0 and 100. Default: `85`.
      */
     quality?: number;
     /**
@@ -122,7 +125,8 @@ export type DefaultMediaLibraryConfig = {
     /**
      * File transformation option map. The key is an
      * original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported
-     * raster image format.
+     * raster image format. See our
+     * [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.
      */
     transformations?: FileTransformations;
 };
@@ -136,7 +140,7 @@ export type DefaultMediaLibrary = {
     config?: DefaultMediaLibraryConfig;
 };
 /**
- * Options for the Cloudinary media library.
+ * Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/).
  */
 export type CloudinaryMediaLibrary = {
     /**
@@ -154,15 +158,16 @@ export type CloudinaryMediaLibrary = {
      */
     use_secure_url?: boolean;
     /**
-     * Options to be passed to Uploadcare, such as `multiple`.
+     * Options to be passed to Cloudinary, such as `multiple`.
      * The `cloud_name` and `api_key` options are required for the global `media_library` option. See
-     * https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a
-     * full list of available options.
+     * the [Cloudinary
+     * documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options)
+     * for a full list of available options.
      */
     config?: Record<string, any>;
 };
 /**
- * Settings for the Uploadcare media library.
+ * Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).
  */
 export type UploadcareMediaLibrarySettings = {
     /**
@@ -177,13 +182,14 @@ export type UploadcareMediaLibrarySettings = {
     defaultOperations?: string;
 };
 /**
- * Options for the Uploadcare media library.
+ * Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).
  */
 export type UploadcareMediaLibrary = {
     /**
      * Options to be passed to Uploadcare, such as `multiple`.
-     * The `publicKey` option is required for the global `media_library` option. See
-     * https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options.
+     * The `publicKey` option is required for the global `media_library` option. See the [Uploadcare
+     * documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of
+     * available options.
      */
     config?: Record<string, any>;
     /**
@@ -207,11 +213,13 @@ export type StockAssetMediaLibrary = {
     providers?: StockAssetProviderName[];
 };
 /**
- * Supported media library.
+ * Supported [media library](https://decapcms.org/docs/configuration-options/#media-library).
  */
 export type MediaLibrary = DefaultMediaLibrary | CloudinaryMediaLibrary | UploadcareMediaLibrary | StockAssetMediaLibrary;
 /**
- * Unified media library option that supports multiple libraries.
+ * Unified media library option that supports multiple libraries. See our
+ * [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for
+ * details.
  */
 export type MediaLibraries = {
     /**
@@ -233,9 +241,9 @@ export type MediaLibraries = {
     stock_assets?: StockAssetMediaLibrary;
 };
 /**
- * Common field properties.
+ * Base field properties that are common to all fields.
  */
-export type CommonFieldProps = {
+export type BaseFieldProps = {
     /**
      * Unique identifier for the field. It cannot include periods and spaces.
      */
@@ -250,10 +258,32 @@ export type CommonFieldProps = {
      */
     comment?: string;
     /**
-     * Name of a widget that defines the input UI and data type. Default:
-     * `string`.
+     * Help message to be displayed below the input UI. Limited Markdown
+     * formatting is supported: bold, italic, strikethrough and links.
+     */
+    hint?: string;
+    /**
+     * Whether to show the preview of the field. Default: `true`.
      */
-    widget?: string;
+    preview?: boolean;
+    /**
+     * Whether to enable the editor UI
+     * in locales other than the default locale. Default: `false`. `duplicate` disables the UI in
+     * non-default like `false` but automatically copies the default locale’s value to other locales.
+     * `translate` and `none` are aliases of `true` and `false`, respectively. This option only works
+     * when i18n is set up with the global and collection-level `i18n` option.
+     */
+    i18n?: boolean | "duplicate" | "translate" | "none";
+};
+/**
+ * Common field properties. We have to allow arbitrary properties because custom widgets can have
+ * any properties. This is also required to enable schema autocomplete for the fields in IDEs.
+ */
+export type CommonFieldProps = BaseFieldProps & Record<string, any>;
+/**
+ * Standard field properties for a built-in widget.
+ */
+export type StandardFieldProps = {
     /**
      * Whether to make data input on the field required.
      * Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global
@@ -272,23 +302,6 @@ export type CommonFieldProps = {
      * message. This option has no effect on a List or Object field with subfields.
      */
     pattern?: [string | RegExp, string];
-    /**
-     * Help message to be displayed below the input UI. Limited Markdown
-     * formatting is supported: bold, italic, strikethrough and links.
-     */
-    hint?: string;
-    /**
-     * Whether to show the preview of the field. Default: `true`.
-     */
-    preview?: boolean;
-    /**
-     * Whether to enable the editor UI
-     * in locales other than the default locale. Default: `false`. `duplicate` disables the UI in
-     * non-default like `false` but automatically copies the default locale’s value to other locales.
-     * `translate` and `none` are aliases of `true` and `false`, respectively. This option only works
-     * when i18n is set up with the global and collection-level `i18n` option.
-     */
-    i18n?: boolean | "duplicate" | "translate" | "none";
 };
 /**
  * Field-level media library options.
@@ -309,8 +322,9 @@ export type MediaFieldProps = {
     default?: string;
     /**
      * File types that the field should accept. The value would be a
-     * comma-separated list of unique file type specifiers, the format used for the HTML `accept`
-     * attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept.
+     * comma-separated list of unique file type specifiers, the format used for the HTML
+     * [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept)
+     * attribute.
      */
     accept?: string;
     /**
@@ -349,11 +363,11 @@ export type MediaFieldProps = {
  */
 export type MultiValueFieldProps = {
     /**
-     * Minimum number of items that can be added. Default: 0.
+     * Minimum number of items that can be added. Default: `0`.
      */
     min?: number;
     /**
-     * Maximum number of items that can be added. Default: infinity.
+     * Maximum number of items that can be added. Default: `Infinity`.
      */
     max?: number;
 };
@@ -367,17 +381,17 @@ export type MultiOptionFieldProps = {
     multiple?: boolean;
     /**
      * Minimum number of items that can be selected. Ignored if `multiple` is
-     * `false`. Default: 0.
+     * `false`. Default: `0`.
      */
     min?: number;
     /**
      * Maximum number of items that can be selected. Ignored if `multiple` is
-     * `false`. Default: infinity.
+     * `false`. Default: `Infinity`.
      */
     max?: number;
     /**
      * Maximum number of options to be displayed as radio
-     * buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: 5.
+     * buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.
      */
     dropdown_threshold?: number;
 };
@@ -403,8 +417,8 @@ export type VariableFieldType = {
      */
     summary?: string;
     /**
-     * Set of subfields. This option can be omitted; in that case, only
-     * the `type` property will be saved.
+     * Set of subfields. This option can be omitted; in that case, only the
+     * `type` property will be saved.
      */
     fields?: Field[];
 };
@@ -443,12 +457,12 @@ export type AdjacentLabelProps = {
 export type CharCountProps = {
     /**
      * Minimum number of characters that can be entered in the input.
-     * Default: 0.
+     * Default: `0`.
      */
     minlength?: number;
     /**
      * Maximum number of characters that can be entered in the input.
-     * Default: infinity.
+     * Default: `Infinity`.
      */
     maxlength?: number;
 };
@@ -468,7 +482,7 @@ export type BooleanFieldProps = {
 /**
  * Boolean field definition.
  */
-export type BooleanField = CommonFieldProps & BooleanFieldProps & AdjacentLabelProps;
+export type BooleanField = CommonFieldProps & StandardFieldProps & BooleanFieldProps & AdjacentLabelProps;
 /**
  * Code field properties.
  */
@@ -483,9 +497,9 @@ export type CodeFieldProps = {
      */
     default?: string | Record<string, string>;
     /**
-     * Default language to be selected, like `js`. See
-     * https://prismjs.com/#supported-languages for a list of supported languages. Default: empty
-     * string, which is plaintext.
+     * Default language to be selected, like `js`. See the [Prism
+     * documentation](https://prismjs.com/#supported-languages) for a list of supported languages.
+     * Default: empty string, which is plaintext.
      */
     default_language?: string;
     /**
@@ -509,7 +523,7 @@ export type CodeFieldProps = {
 /**
  * Code field definition.
  */
-export type CodeField = CommonFieldProps & CodeFieldProps;
+export type CodeField = CommonFieldProps & StandardFieldProps & CodeFieldProps;
 /**
  * Color field properties.
  */
@@ -536,7 +550,7 @@ export type ColorFieldProps = {
 /**
  * Color field definition.
  */
-export type ColorField = CommonFieldProps & ColorFieldProps;
+export type ColorField = CommonFieldProps & StandardFieldProps & ColorFieldProps;
 /**
  * Compute field properties.
  */
@@ -553,7 +567,7 @@ export type ComputeFieldProps = {
 /**
  * Compute field definition.
  */
-export type ComputeField = CommonFieldProps & ComputeFieldProps;
+export type ComputeField = CommonFieldProps & StandardFieldProps & ComputeFieldProps;
 /**
  * DateTime field properties.
  */
@@ -568,20 +582,22 @@ export type DateTimeFieldProps = {
      */
     default?: string;
     /**
-     * Storage format written in Moment.js tokens. See
-     * https://momentjs.com/docs/#/displaying/format/ for supported tokens. Default: ISO 8601 format.
+     * Storage format written in [Moment.js
+     * tokens](https://momentjs.com/docs/#/displaying/format/). Default: ISO 8601 format.
      */
     format?: string;
     /**
-     * Date storage format written in Moment.js tokens if the
-     * value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used
-     * unless the `format` option is defined. If `false`, date input/output is disabled.
+     * Date storage format written in [Moment.js
+     * tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format`
+     * option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined.
+     * If `false`, date input/output is disabled.
      */
     date_format?: string | boolean;
     /**
-     * Time storage format written in Moment.js tokens if the
-     * value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used
-     * unless the `format` option is defined. If `false`, time input/output is disabled.
+     * Time storage format written in [Moment.js
+     * tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format`
+     * option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined.
+     * If `false`, time input/output is disabled.
      */
     time_format?: string | boolean;
     /**
@@ -592,7 +608,7 @@ export type DateTimeFieldProps = {
 /**
  * DateTime field definition.
  */
-export type DateTimeField = CommonFieldProps & DateTimeFieldProps;
+export type DateTimeField = CommonFieldProps & StandardFieldProps & DateTimeFieldProps;
 /**
  * File field properties.
  */
@@ -605,7 +621,7 @@ export type FileFieldProps = {
 /**
  * File field definition.
  */
-export type FileField = CommonFieldProps & MediaFieldProps & FileFieldProps;
+export type FileField = CommonFieldProps & StandardFieldProps & MediaFieldProps & FileFieldProps;
 /**
  * Hidden field properties.
  */
@@ -623,7 +639,7 @@ export type HiddenFieldProps = {
 /**
  * Hidden field definition.
  */
-export type HiddenField = CommonFieldProps & HiddenFieldProps;
+export type HiddenField = CommonFieldProps & StandardFieldProps & HiddenFieldProps;
 /**
  * Image field properties.
  */
@@ -636,9 +652,9 @@ export type ImageFieldProps = {
 /**
  * Image field definition.
  */
-export type ImageField = CommonFieldProps & MediaFieldProps & ImageFieldProps;
+export type ImageField = CommonFieldProps & StandardFieldProps & MediaFieldProps & ImageFieldProps;
 /**
- * KeyValue field properties.
+ * KeyValue field properties compatible with Static CMS.
  */
 export type KeyValueFieldProps = {
     /**
@@ -661,7 +677,7 @@ export type KeyValueFieldProps = {
 /**
  * KeyValue field definition.
  */
-export type KeyValueField = CommonFieldProps & KeyValueFieldProps & MultiValueFieldProps;
+export type KeyValueField = CommonFieldProps & StandardFieldProps & KeyValueFieldProps & MultiValueFieldProps;
 /**
  * List field properties.
  */
@@ -717,15 +733,16 @@ export type ListFieldProps = {
     /**
      * Whether to save the field value at the top-level of the data file
      * without the field name. If the `single_file` i18n structure is enabled, the lists will still be
-     * saved under locale keys. Default: `false`. See
-     * https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list for details.
+     * saved under locale keys. Default: `false`. See our
+     * [README](https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list) for
+     * details.
      */
     root?: boolean;
 };
 /**
  * List field definition.
  */
-export type ListField = CommonFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
+export type ListField = CommonFieldProps & StandardFieldProps & ListFieldProps & MultiValueFieldProps & VariableFieldProps;
 /**
  * Map field properties.
  */
@@ -735,23 +752,24 @@ export type MapFieldProps = {
      */
     widget: "map";
     /**
-     * Default value. Accepts a stringified single GeoJSON geometry object
-     * that contains `type` and `coordinates` properties.
+     * Default value. Accepts a stringified single
+     * [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates`
+     * properties.
      */
     default?: string;
     /**
-     * Precision of coordinates to be saved. Default: 7.
+     * Precision of coordinates to be saved. Default: `7`.
      */
     decimals?: number;
     /**
-     * Geometry type. Default: Point.
+     * Geometry type. Default: `Point`.
      */
     type?: "Point" | "LineString" | "Polygon";
 };
 /**
  * Map field definition.
  */
-export type MapField = CommonFieldProps & MapFieldProps;
+export type MapField = CommonFieldProps & StandardFieldProps & MapFieldProps;
 /**
  * Supported button name for the rich text editor.
  */
@@ -812,7 +830,7 @@ export type MarkdownFieldProps = {
 /**
  * Markdown field definition.
  */
-export type MarkdownField = CommonFieldProps & MarkdownFieldProps;
+export type MarkdownField = CommonFieldProps & StandardFieldProps & MarkdownFieldProps;
 /**
  * Number field properties.
  */
@@ -830,22 +848,22 @@ export type NumberFieldProps = {
      */
     value_type?: "int" | "float" | string;
     /**
-     * Minimum value that can be entered in the input. Default: undefined.
+     * Minimum value that can be entered in the input. Default: `-Infinity`.
      */
     min?: number;
     /**
-     * Maximum value that can be entered in the input. Default: undefined.
+     * Maximum value that can be entered in the input. Default: `Infinity`.
      */
     max?: number;
     /**
-     * Number to increase/decrease with the arrow key/button. Default: 1.
+     * Number to increase/decrease with the arrow key/button. Default: `1`.
      */
     step?: number;
 };
 /**
  * Number field definition.
  */
-export type NumberField = CommonFieldProps & NumberFieldProps & AdjacentLabelProps;
+export type NumberField = CommonFieldProps & StandardFieldProps & NumberFieldProps & AdjacentLabelProps;
 /**
  * Object field properties.
  */
@@ -876,7 +894,7 @@ export type ObjectFieldProps = {
 /**
  * Object field definition.
  */
-export type ObjectField = CommonFieldProps & ObjectFieldProps & VariableFieldProps;
+export type ObjectField = CommonFieldProps & StandardFieldProps & ObjectFieldProps & VariableFieldProps;
 /**
  * Entry filter options for a Relation field.
  */
@@ -938,7 +956,7 @@ export type RelationFieldProps = {
 /**
  * Relation field definition.
  */
-export type RelationField = CommonFieldProps & RelationFieldProps & MultiOptionFieldProps;
+export type RelationField = CommonFieldProps & StandardFieldProps & RelationFieldProps & MultiOptionFieldProps;
 /**
  * Select field properties.
  */
@@ -963,7 +981,7 @@ export type SelectFieldProps = {
 /**
  * Select field definition.
  */
-export type SelectField = CommonFieldProps & SelectFieldProps & MultiOptionFieldProps;
+export type SelectField = CommonFieldProps & StandardFieldProps & SelectFieldProps & MultiOptionFieldProps;
 /**
  * String field properties.
  */
@@ -971,14 +989,14 @@ export type StringFieldProps = {
     /**
      * Widget name.
      */
-    widget: "string";
+    widget?: "string";
     /**
      * Default value.
      */
     default?: string;
     /**
      * Data type. It’s useful when the input value needs a
-     * validation. Default: text.
+     * validation. Default: `text`.
      */
     type?: "text" | "url" | "email";
     /**
@@ -993,7 +1011,7 @@ export type StringFieldProps = {
 /**
  * String field definition.
  */
-export type StringField = CommonFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
+export type StringField = CommonFieldProps & StandardFieldProps & StringFieldProps & AdjacentLabelProps & CharCountProps;
 /**
  * Text field properties.
  */
@@ -1010,7 +1028,7 @@ export type TextFieldProps = {
 /**
  * Text field definition.
  */
-export type TextField = CommonFieldProps & TextFieldProps & CharCountProps;
+export type TextField = CommonFieldProps & StandardFieldProps & TextFieldProps & CharCountProps;
 /**
  * UUID field properties.
  */
@@ -1039,15 +1057,29 @@ export type UuidFieldProps = {
 /**
  * UUID field definition.
  */
-export type UuidField = CommonFieldProps & UuidFieldProps;
+export type UuidField = CommonFieldProps & StandardFieldProps & UuidFieldProps;
 /**
  * Entry field using a built-in widget.
  */
 export type StandardField = BooleanField | CodeField | ColorField | ComputeField | DateTimeField | FileField | HiddenField | ImageField | KeyValueField | ListField | MapField | MarkdownField | NumberField | ObjectField | RelationField | SelectField | StringField | TextField | UuidField;
 /**
- * Entry field using a custom widget. It can contain any properties.
+ * Name of a built-in widget. Sveltia CMS supports all the built-in widgets provided by Decap CMS as
+ * well as some new widgets.
+ */
+export type BuiltInWidgetName = "boolean" | "code" | "color" | "compute" | "datetime" | "file" | "hidden" | "image" | "keyvalue" | "list" | "map" | "markdown" | "number" | "object" | "relation" | "select" | "string" | "text" | "uuid";
+/**
+ * Custom field properties.
+ */
+export type CustomFieldProps = {
+    /**
+     * Widget name.
+     */
+    widget: Exclude<string, BuiltInWidgetName>;
+};
+/**
+ * Entry field using a custom widget.
  */
-export type CustomField = CommonFieldProps & Record<string, any>;
+export type CustomField = CommonFieldProps & CustomFieldProps;
 /**
  * Entry field.
  */
@@ -1077,22 +1109,24 @@ export type I18nOptions = {
     /**
      * Locales to be enabled when
      * creating a new entry draft. If this option is used, users will be able to disable the output of
-     * non-default locales through the UI. See
-     * https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details.
+     * non-default locales through the UI. See our
+     * [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for
+     * details.
      */
     initial_locales?: LocaleCode[] | "all" | "default";
     /**
      * Whether to save collection entries in all the locales. If
-     * `false`, users will be able to disable the output of non-default locales through the UI. See
-     * https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details.
+     * `false`, users will be able to disable the output of non-default locales through the UI. See our
+     * [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for
+     * details.
      */
     save_all_locales?: boolean;
     /**
      * Property name and value template used
      * to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link
      * localized files when entry slugs are localized. The default property name is `translationKey`
-     * used in Hugo’s multilingual support, and the default value is the default locale’s slug. See
-     * https://github.com/sveltia/sveltia-cms#localizing-entry-slugs for details.
+     * used in Hugo’s multilingual support, and the default value is the default locale’s slug. See our
+     * [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details.
      */
     canonical_slug?: {
         key: string;
@@ -1102,8 +1136,8 @@ export type I18nOptions = {
      * Whether to exclude the default locale
      * from entry filenames. Default: `false`. This option applies to entry collections with the
      * `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the
-     * `file` path ending with `.{{locale}}.<extension>`, aiming to support Zola’s multilingual sites:
-     * https://www.getzola.org/documentation/content/multilingual/.
+     * `file` path ending with `.{{locale}}.<extension>`, aiming to support [Zola’s multilingual
+     * sites](https://www.getzola.org/documentation/content/multilingual/).
      */
     omit_default_locale_from_filename?: boolean;
 };
@@ -1120,8 +1154,11 @@ export type CollectionFile = {
      */
     label?: string;
     /**
-     * Name of a Material Symbols icon to be displayed in the collection file
-     * list and other places.
+     * Name of a [Material Symbols
+     * icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection
+     * file list and other places. See our
+     * [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for
+     * details.
      */
     icon?: string;
     /**
@@ -1158,12 +1195,6 @@ export type CollectionFile = {
      * I18n options. Default: `false`.
      */
     i18n?: I18nOptions | boolean;
-    /**
-     * A special option to make this file a divider UI in the singleton
-     * file list. Default: `false`. Not supported in a file collection. If `true`, other options will be
-     * ignored, but you still have to provide a unique `name`.
-     */
-    divider?: boolean;
     /**
      * Preview URL path template.
      */
@@ -1174,7 +1205,7 @@ export type CollectionFile = {
     preview_path_date_field?: FieldKeyPath;
 };
 /**
- * Supported file extension.
+ * Supported file extension. Actually it can be any string.
  */
 export type FileExtension = "yml" | "yaml" | "toml" | "json" | "md" | "markdown" | "html" | string;
 /**
@@ -1227,8 +1258,9 @@ export type SortableFields = {
      */
     fields: FieldKeyPath[];
     /**
-     * Default sort settings. See
-     * https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction for details.
+     * Default sort settings. See our
+     * [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for
+     * details.
      */
     default?: SortableFieldsDefaultOptions;
 };
@@ -1281,7 +1313,7 @@ export type EditorOptions = {
 export type NestedCollectionOptions = {
     /**
      * Maximum depth to show nested items in the collection tree. Default:
-     * infinity.
+     * `Infinity`.
      */
     depth?: number;
     /**
@@ -1316,7 +1348,9 @@ export type CollectionMetaData = {
     path?: CollectionMetaDataPath;
 };
 /**
- * Index file inclusion options.
+ * Index file inclusion options. See our
+ * [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection)
+ * for details.
  */
 export type CollectionIndexFile = {
     /**
@@ -1330,7 +1364,8 @@ export type CollectionIndexFile = {
      */
     label?: string;
     /**
-     * Name of a Material Symbols icon to be displayed in the editor UI.
+     * Name of a [Material Symbols
+     * icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI.
      * Default: `home`.
      */
     icon?: string;
@@ -1344,6 +1379,25 @@ export type CollectionIndexFile = {
      */
     editor?: EditorOptions;
 };
+/**
+ * A divider in the collection list and singleton list. See our
+ * [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for
+ * details.
+ */
+export type CollectionDivider = {
+    /**
+     * Unique identifier for the divider. Can be omitted, but it must be
+     * unique across all the collections and singletons. This property is included here because in the
+     * previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option
+     * set to `true`, and the `name` option was required.
+     */
+    name?: string;
+    /**
+     * Whether to make this collection a divider UI in the collection list.
+     * It must be `true` to be used as a divider.
+     */
+    divider: boolean;
+};
 /**
  * A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is
  * called an entry collection.
@@ -1369,7 +1423,9 @@ export type Collection = {
      */
     description?: string;
     /**
-     * Name of a Material Symbols icon to be displayed in the collection list.
+     * Name of a [Material Symbols
+     * icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection
+     * list.
      */
     icon?: string;
     /**
@@ -1396,7 +1452,11 @@ export type Collection = {
     path?: string;
     /**
      * Internal media folder path for the collection. This overrides
-     * the global `media_folder` option.
+     * the global `media_folder` option. It can be a relative path from the project root if it starts
+     * with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global
+     * `media_folder` option value is used. See our
+     * [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for
+     * details.
      */
     media_folder?: string;
     /**
@@ -1443,12 +1503,14 @@ export type Collection = {
     frontmatter_delimiter?: string | string[];
     /**
      * Item slug template. Entry collection only. Default: `identifier_field`
-     * option value.
+     * option value. It’s possible to [localize the
+     * slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or [use a random
+     * ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug).
      */
     slug?: string;
     /**
      * The maximum number of characters allowed for an entry slug.
-     * Entry collection only. Default: infinity.
+     * Entry collection only. Default: `Infinity`.
      */
     slug_length?: number;
     /**
@@ -1459,7 +1521,9 @@ export type Collection = {
     /**
      * Custom sortable fields. Entry
      * collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend,
-     * commit author and commit date are also included by default.
+     * commit author and commit date are also included by default. See our
+     * [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for
+     * details.
      */
     sortable_fields?: FieldKeyPath[] | SortableFields;
     /**
@@ -1500,7 +1564,9 @@ export type Collection = {
     /**
      * Index file inclusion options. Entry
      * collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s
-     * special index file.
+     * special index file. See our
+     * [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection)
+     * for details.
      */
     index_file?: CollectionIndexFile | boolean;
     /**
@@ -1509,12 +1575,6 @@ export type Collection = {
      * options.
      */
     yaml_quote?: boolean;
-    /**
-     * A special option to make this collection a divider UI in the
-     * collection list. Default: `false`. If `true`, other options will be ignored, but you still have
-     * to provide a unique `name`.
-     */
-    divider?: boolean;
     /**
      * A field key path to be used to find an
      * entry thumbnail displayed on the entry list. A nested field can be specified using dot notation,
@@ -1525,7 +1585,7 @@ export type Collection = {
     thumbnail?: FieldKeyPath | FieldKeyPath[];
     /**
      * The maximum number of entries that can be created in the collection.
-     * Entry collection only. Default: infinity.
+     * Entry collection only. Default: `Infinity`.
      */
     limit?: number;
 };
@@ -1599,14 +1659,15 @@ export type BackendOptions = {
     graphql_api_root?: string;
     /**
      * Site domain used for OAuth, which will be included in the
-     * `site_id` param to be sent to the API endpoint. Git backends only. Default: `location.hostname`.
+     * `site_id` param to be sent to the API endpoint. Git backends only. Default:
+     * [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname).
      */
     site_domain?: string;
     /**
      * OAuth base URL origin. Git backends only. Required when using an
-     * OAuth client other than Netlify, including Sveltia CMS Authenticator. Default:
-     * `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/`
-     * (Gitea).
+     * OAuth client other than Netlify, including [Sveltia CMS
+     * Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com`
+     * (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea).
      */
     base_url?: string;
     /**
@@ -1654,8 +1715,8 @@ export type BackendOptions = {
     /**
      * Whether to enable or disable automatic deployments
      * with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the
-     * `[skip ci]` prefix will be added to commit messages. Git backends only. Default: undefined. See
-     * https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details.
+     * `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See
+     * our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.
      */
     automatic_deployments?: boolean;
 };
@@ -1694,7 +1755,7 @@ export type JsonFormatOptions = {
      */
     indent_style?: "space" | "tab";
     /**
-     * Indent size. Default: 2.
+     * Indent size. Default: `2`.
      */
     indent_size?: number;
 };
@@ -1703,7 +1764,7 @@ export type JsonFormatOptions = {
  */
 export type YamlFormatOptions = {
     /**
-     * Indent size. Default: 2.
+     * Indent size. Default: `2`.
      */
     indent_size?: number;
     /**
@@ -1744,8 +1805,8 @@ export type OutputOptions = {
 export type SiteConfig = {
     /**
      * Whether to load YAML/JSON site configuration file(s) when
-     * manually initializing the CMS. This works only in the `CMS.init()` method’s `config` option.
-     * Default: `true`.
+     * [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works
+     * only in the `CMS.init()` method’s `config` option. Default: `true`.
      */
     load_config_file?: boolean;
     /**
@@ -1775,11 +1836,14 @@ export type SiteConfig = {
     media_library?: MediaLibrary & GlobalMediaLibraryOptions;
     /**
      * Unified media library option that supports multiple
-     * libraries.
+     * libraries. See our
+     * [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for
+     * details.
      */
     media_libraries?: MediaLibraries;
     /**
-     * Site URL. Default: current site’s origin (`location.origin`).
+     * Site URL. Default: current site’s origin
+     * ([`location.origin`](https://developer.mozilla.org/en-US/docs/Web/API/Location/origin)).
      */
     site_url?: string;
     /**
@@ -1801,15 +1865,17 @@ export type SiteConfig = {
      */
     slug?: SlugOptions;
     /**
-     * Set of collections.
+     * Set of collections. The list can also
+     * contain dividers, which are used to group collections in the collection list.
      */
-    collections: Collection[];
+    collections: (Collection | CollectionDivider)[];
     /**
-     * Set of singleton files, such as the site configuration
-     * file or the homepage file. They are not part of any collection and can be accessed directly
-     * through the collection list.
+     * Set of singleton files, such as
+     * the site configuration file or the homepage file. They are not part of any collection and can be
+     * accessed directly through the collection list. The list can also contain dividers. See our
+     * [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details.
      */
-    singletons?: CollectionFile[];
+    singletons?: (CollectionFile | CollectionDivider)[];
     /**
      * Global i18n options.
      */
@@ -1819,7 +1885,8 @@ export type SiteConfig = {
      */
     editor?: EditorOptions;
     /**
-     * Data output options.
+     * Data output options. See our
+     * [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details.
      */
     output?: OutputOptions;
 };
@@ -1844,7 +1911,8 @@ export type EditorComponentDefinition = {
      */
     label: string;
     /**
-     * Name of a Material Symbols icon to be displayed in the editor UI.
+     * Name of a [Material Symbols
+     * icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI.
      */
     icon?: string;
     /**