From b050162f820c1ef3a75c20b3b1b51e42bb6144aa Mon Sep 17 00:00:00 2001
From: sou7 <17077205+soukouki@users.noreply.github.com>
Date: Thu, 27 Feb 2025 21:37:01 +0000
Subject: [PATCH] docs(frontmatter): mention dealiasing related fields (#1715)

---
 docs/authoring content.md           |    2 ++
 docs/plugins/CreatedModifiedDate.md |    2 ++
 docs/plugins/Frontmatter.md         |   48 ++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 52 insertions(+), 0 deletions(-)

diff --git a/docs/authoring content.md b/docs/authoring content.md
index 178f44a..623357f 100644
--- a/docs/authoring content.md
+++ b/docs/authoring content.md
@@ -35,6 +35,8 @@
 - `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz.
 - `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format.
 
+See [[Frontmatter]] for a complete list of frontmatter.
+
 ## Syncing your Content
 
 When your Quartz is at a point you're happy with, you can save your changes to GitHub.
diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md
index f4134c4..2d1eaee 100644
--- a/docs/plugins/CreatedModifiedDate.md
+++ b/docs/plugins/CreatedModifiedDate.md
@@ -13,6 +13,8 @@
 
 - `priority`: The data sources to consult for date information. Highest priority first. Possible values are `"frontmatter"`, `"git"`, and `"filesystem"`. Defaults to `["frontmatter", "git", "filesystem"]`.
 
+When loading the frontmatter, the value of [[Frontmatter#List]] is used.
+
 > [!warning]
 > If you rely on `git` for dates, make sure `defaultDateType` is set to `modified` in `quartz.config.ts`.
 >
diff --git a/docs/plugins/Frontmatter.md b/docs/plugins/Frontmatter.md
index 879d087..9dfe533 100644
--- a/docs/plugins/Frontmatter.md
+++ b/docs/plugins/Frontmatter.md
@@ -17,6 +17,54 @@
 > [!warning]
 > This plugin must not be removed, otherwise Quartz will break.
 
+## List
+
+Quartz supports the following frontmatter:
+
+- title
+  - `title`
+- description
+  - `description`
+- permalink
+  - `permalink`
+- comments
+  - `comments`
+- lang
+  - `lang`
+- publish
+  - `publish`
+- draft
+  - `draft`
+- enableToc
+  - `enableToc`
+- tags
+  - `tags`
+  - `tag`
+- aliases
+  - `aliases`
+  - `alias`
+- cssclasses
+  - `cssclasses`
+  - `cssclass`
+- socialDescription
+  - `socialDescription`
+- socialImage
+  - `socialImage`
+  - `image`
+  - `cover`
+- created
+  - `created`
+  - `date`
+- modified
+  - `modified`
+  - `lastmod`
+  - `updated`
+  - `last-modified`
+- published
+  - `published`
+  - `publishDate`
+  - `date`
+
 ## API
 
 - Category: Transformer

--
Gitblit v1.10.0