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

Add example of frontmatter keys needed for new post #27

Open
maxcell opened this issue Mar 1, 2022 · 0 comments
Open

Add example of frontmatter keys needed for new post #27

maxcell opened this issue Mar 1, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@maxcell
Copy link
Contributor

maxcell commented Mar 1, 2022

Given a conversation within the Jamstack Discord, I think it is important for us to document what is needed for a new post so users can easily get running. An easy lift would be putting this into the README. Enough there to solve awareness.


As an aside, I wonder if there is any way for us to essentially throw a more helpful error around if the front matter wasn't properly setup so that folks get insights on "oh hey, you're missing a front matter key, be sure to add this". Rather than:

5:08:12 PM: Error occurred prerendering page "/posts/test-post". Read more: https://nextjs.org/docs/messages/prerender-error
5:08:12 PM: Error: Error serializing `.prevPost.title` returned from `getStaticProps` in "/posts/[slug]".
5:08:12 PM: Reason: `undefined` cannot be serialized as JSON. Please use `null` or omit this value.
@maxcell maxcell added the documentation Improvements or additions to documentation label Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants
@maxcell and others