Collections

A collection is a set of files sharing the same structure and usually saved in the same folder. You might use a collection for blog posts, product pages, author data files, etc.

To define a collection in LumeCMS you need 3 things:

• The collection name. For example: "Posts".
• The storage used to read and write the content. Probably "src".
• The fields used to modify the content.

The function cms.collection() allows to define a collection:

cms.collection("posts", "src:posts/*.md", [
  "title: text",
  "content: markdown",
]);

In the example above, we have defined the posts collection, using the src storage (selecting all .md files inside the posts folder). The third argument is the list of fields for this collection. See fields documentation for more info about this value.

Collections can create, edit and remove documents.

You can include a short description that will be visible in the UI with the format name: description. For example:

cms.collection(
  "posts: Here you add, edit or delete the posts of your blog",
  "src:posts/*.md",
  [
    "title: text",
    "content: markdown",
  ],
);