Documents

Documents allows to define individual files that can be edited directly in the CMS. Unlike collections, documents can be edited, but not removed or created. It's useful if you want to be able to edit configuration files, data files or unique pages like the landing page.

To define a document in LumeCMS you need 3 things:

• The document name. For example: "Landing page".
• The storage used to read and write the content of this page.
• The fields used to modify the content.

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

cms.document("landing-page", "src:index.yml", [
  "title: text",
  "subtitle: text",
  "content: markdown",
]);

In the example above, we have defined the landing-page document, that is saved in the index.yml file in the src storage. In the CMS we can edit the title, subtitle and content fields. See fields documentation for more info about how to configure the document fields.

Extra options

For additional options, use an object like this:

cms.document({
  name: "landing-page",
  store: "src:index.yml",
  fields: [
    "title: text",
    "subtitle: text",
    "content: markdown",
  ],
});

In addition to name, store and fields, documents have the following options:

description

It allows to insert a description below the document name:

cms.document({
  name: "landing-page",
  description: "Edit the content of the landing page",
  store: "src:index.yml",
  fields: [
    "title: text",
    "subtitle: text",
    "content: markdown",
  ],
});

label

The visible name of this document in the menu. If it's not defined, the name value is used.

cms.document({
  name: "landing-page",
  label: "This is your homepage",
  description: "Edit the content of the home page",
  store: "src:index.yml",
  fields: [
    "title: text",
    "subtitle: text",
    "content: markdown",
  ],
});