Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(frontmatter): mention dealiasing related fields #1715

Open
wants to merge 3 commits into
base: v4
Choose a base branch
from

Conversation

soukouki
Copy link
Contributor

@soukouki soukouki commented Jan 8, 2025

As the title says.

@soukouki soukouki force-pushed the soukouki/edit-created-modified-date branch from d9f46a6 to 73d5e3f Compare January 8, 2025 11:43
@soukouki soukouki closed this Jan 8, 2025
@soukouki

This comment was marked as resolved.

@soukouki soukouki reopened this Jan 8, 2025
Copy link
Collaborator

@aarnphm aarnphm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one

Comment on lines 16 to 29
If frontmatter is specified, the following frontmatter values are referenced:

- created
- `created`
- `date`
- modified
- `modified`
- `lastmod`
- `updated`
- `last-modified`
- published
- `published`
- `publishDate`
- `date`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a better wording for this is:

Quartz dealiased the following frontmatter value if the default does not exists (then you can link to the source of this dealias)

Fwiw can you also mention all of the field for that items that we dealias from frontmatter (probably we should add that in the frontmatter docs, then wikilinks to each of the relevant features, such as modified date)

@aarnphm aarnphm changed the title Added to the documentation which values of frontmatter are referenced. docs(frontmatter): mention dealiasing related fields Jan 8, 2025
@soukouki
Copy link
Contributor Author

soukouki commented Jan 9, 2025

Only frontmatter processed in frontmatter.ts had more than one name, with processing scattered across each file, such as title. So links to the source code were omitted.

I'm not sure whether to even include a description of each frontmatter option, but I'm struggling with this as it duplicates the description of Authoring Content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants