From 73d5e3f96cd813061748400e2d56e6c5d647d61c Mon Sep 17 00:00:00 2001 From: soukouki Date: Wed, 8 Jan 2025 20:43:33 +0900 Subject: [PATCH 1/3] Added to the documentation which values of frontmatter are referenced. --- docs/plugins/CreatedModifiedDate.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md index f4134c478..d33c3e370 100644 --- 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`. > From ecfaff3f42089f4816c5ecea8fe925c7b54b1ce6 Mon Sep 17 00:00:00 2001 From: soukouki Date: Wed, 8 Jan 2025 20:52:28 +0900 Subject: [PATCH 2/3] The source code I was looking at seemed to be out of date and the wrong listings were corrected. --- docs/plugins/CreatedModifiedDate.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/plugins/CreatedModifiedDate.md b/docs/plugins/CreatedModifiedDate.md index d33c3e370..2be5e6bc4 100644 --- a/docs/plugins/CreatedModifiedDate.md +++ b/docs/plugins/CreatedModifiedDate.md @@ -16,13 +16,17 @@ This plugin accepts the following configuration options: If frontmatter is specified, the following frontmatter values are referenced: - created + - `created` - `date` - modified + - `modified` - `lastmod` - `updated` - `last-modified` - published + - `published` - `publishDate` + - `date` > [!warning] > If you rely on `git` for dates, make sure `defaultDateType` is set to `modified` in `quartz.config.ts`. From d4b1cfac1e49ef6151b3678fabbf874a3a6d3267 Mon Sep 17 00:00:00 2001 From: soukouki Date: Thu, 9 Jan 2025 16:36:14 +0900 Subject: [PATCH 3/3] The list of frontmatter was moved to Frontmatter.md and a link was added. --- docs/authoring content.md | 2 ++ docs/plugins/CreatedModifiedDate.md | 15 +-------- docs/plugins/Frontmatter.md | 48 +++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 14 deletions(-) diff --git a/docs/authoring content.md b/docs/authoring content.md index 178f44af8..623357fc3 100644 --- a/docs/authoring content.md +++ b/docs/authoring content.md @@ -35,6 +35,8 @@ Some common frontmatter fields that are natively supported by Quartz: - `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 2be5e6bc4..2d1eaeec1 100644 --- a/docs/plugins/CreatedModifiedDate.md +++ b/docs/plugins/CreatedModifiedDate.md @@ -13,20 +13,7 @@ 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 - - `created` - - `date` -- modified - - `modified` - - `lastmod` - - `updated` - - `last-modified` -- published - - `published` - - `publishDate` - - `date` +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 879d087db..9dfe53378 100644 --- a/docs/plugins/Frontmatter.md +++ b/docs/plugins/Frontmatter.md @@ -17,6 +17,54 @@ This plugin accepts the following configuration options: > [!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