mention YAML in Markdown#3203
Merged
Merged
Conversation
sarah11918
added
the
improve or update documentation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
yanthomasdev
approved these changes
May 8, 2023
Member
yanthomasdev
left a comment
yanthomasdev
left a comment
There was a problem hiding this comment.
Nice idea, it's something a lot of people don't know about Markdown in Astro that is useful to add, LGTM!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In response to #3115 , someone was having trouble identifying the correct date format to use in their blog posts. They were not using a date format recognized by YAML, and suggested we define a proper date format to use in docs.
To address this issue more generally, I think adding mention that frontmatter is YAML (which we only do in the tutorial) is more broadly helpful. This defines a Markdown file's frontmatter as being YAML right at the top of the Markdown/MDX page, so that people will have a resource for knowing the language of the frontmatter, and a reference link for usage.