docs(frontmatter): mention dealiasing related fields (#1715)
* Added to the documentation which values of frontmatter are referenced. * The source code I was looking at seemed to be out of date and the wrong listings were corrected. * The list of frontmatter was moved to Frontmatter.md and a link was added.
This commit is contained in:
		@@ -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.
 | 
			
		||||
 
 | 
			
		||||
@@ -13,6 +13,8 @@ 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"]`.
 | 
			
		||||
 | 
			
		||||
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`.
 | 
			
		||||
>
 | 
			
		||||
 
 | 
			
		||||
@@ -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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user