@sveltia/cms 0.119.1 → 0.120.0

package/types/public.d.ts

@@ -1334,9 +1334,9 @@ export type FileExtension = "yml" | "yaml" | "toml" | "json" | "md" | "markdown"
  */
 export type FrontMatterFormat = "yaml-frontmatter" | "toml-frontmatter" | "json-frontmatter";
 /**
- * Supported file format.
+ * Supported file format. Actually it can be any string because of custom formats.
  */
-export type FileFormat = "yml" | "yaml" | "toml" | "json" | "frontmatter" | FrontMatterFormat;
+export type FileFormat = "yml" | "yaml" | "toml" | "json" | "frontmatter" | FrontMatterFormat | string;
 /**
  * Collection filter options.
  */
@@ -1650,7 +1650,8 @@ export type CommonCollectionProps = {
  */
 export type EntryCollectionProps = {
     /**
-     * Base folder path relative to the project root.
+     * Base folder path relative to the project root. It can contain slashes
+     * to create subfolders.
      */
     folder: string;
     /**
@@ -1658,7 +1659,9 @@ export type EntryCollectionProps = {
      */
     fields: Field[];
     /**
-     * File path relative to `folder`, without a file extension.
+     * File path relative to `folder`, without a file extension. It can
+     * contain slashes to create subfolders. Default: `{{slug}}`. To use Hugo’s page bundle, set this to
+     * `{{slug}}/index`.
      */
     path?: string;
     /**
@@ -1685,10 +1688,11 @@ export type EntryCollectionProps = {
      */
     identifier_field?: FieldKeyPath;
     /**
-     * Item slug template. Default: `identifier_field` 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).
-     * Also, it’s possible to show a special slug editor field in initial entry drafts by using
+     * Item slug template. Default: `identifier_field` option value. It cannot
+     * contain slashes; to organize entries in subfolders, use the `path` option instead. 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). Also,
+     * it’s possible to show a special slug editor field in initial entry drafts by using
      * `{{fields._slug}}` (with an underscore prefix) or `{{fields._slug | localize}}` (to localize the
      * slug).
      */