Added to the documentation which values of frontmatter are referenced.

jackyzha0 · Jan 8, 2025 · 73d5e3f · 73d5e3f
1 parent 09f8670
commit 73d5e3f
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md
@@ -13,6 +13,17 @@ This plugin accepts the following configuration options:
 
 - `priority`: The data sources to consult for date information. Highest priority first. Possible values are `"frontmatter"`, `"git"`, and `"filesystem"`. Defaults to `["frontmatter", "git", "filesystem"]`.
 
+If frontmatter is specified, the following frontmatter values are referenced:
+
+- created
+  - `date`
+- modified
+  - `lastmod`
+  - `updated`
+  - `last-modified`
+- published
+  - `publishDate`
+
 > [!warning]
 > If you rely on `git` for dates, make sure `defaultDateType` is set to `modified` in `quartz.config.ts`.
 >