文档

文档允许定义可在 CMS 中直接编辑的独立文件。与集合不同，文档可以被编辑，但不能被删除或创建。如果您希望能够编辑配置文件、数据文件或独特的页面（如着陆页），这将非常有用。

要在 LumeCMS 中定义一个文档，您需要 3 样东西：

• 文档名称。例如："Landing page"。
• 用于读取和写入此页面内容的存储。
• 用于修改内容的字段。

cms.document() 函数允许定义一个文档：

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

在上面的例子中，我们定义了 landing-page 文档，它保存在 src 存储的 index.yml 文件中。在 CMS 中，我们可以编辑 title、subtitle 和 content 字段。有关如何配置文档字段的更多信息，请参阅 字段文档。

额外选项

对于额外的选项，请使用如下对象：

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

除了 name、store 和 fields 之外，文档还有以下选项：

description

它允许在文档名称下方插入描述：

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

此文档在菜单中可见的名称。如果未定义，则使用 name 值。

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",
  ],
});