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

Markdown content prop -> frontmatter prop #1232

Merged
merged 3 commits into from
Aug 12, 2022

Conversation

bholmesdev
Copy link
Contributor

What kind of changes does this PR include?

  • New or updated content

Description

Change all references to the Markdown layout Astro.props.content property to Astro.props.frontmatter. Both will continue to work, but frontmatter should be the new recommendation. Seemed a bit much to add deprecation notices everywhere, so I'm voting for a clean sweep for 1.0 stable here!

@netlify
Copy link

netlify bot commented Aug 8, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 333bbed
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/62f67a78f027af0008492cc0
😎 Deploy Preview https://deploy-preview-1232--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@yanthomasdev
Copy link
Member

Did a scan through the docs Markdown files and I think you covered all the content occurrences, LGTM! Thanks for this @bholmesdev 🙌

@yanthomasdev yanthomasdev added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Aug 8, 2022
@sarah11918
Copy link
Member

@bholmesdev These look good, BUT, the content from integrations-guide/integrations/mdx is mirrored from https://github.com/withastro/astro/tree/main/packages/integrations/mdx/README.md so the changes have to be made there.

Otherwise, I think this is fine!

@bholmesdev
Copy link
Contributor Author

@sarah11918 MDX README updates here!
withastro/astro#4237

@sarah11918
Copy link
Member

sarah11918 commented Aug 10, 2022

@bholmesdev Got it! (See my comment in PTAL re: one other link you could fix on that page for me, while you're there. Or, I can do it before you merge.)

ARE YOU OTHERWISE OK HAPPY WITH THIS PR, and the changes to the other 2 pages?

Also there are conflicts to resolve that either your or I can take care of. They look pretty straightfoward to choose the right thing. TOO MUCH MD/MDX ACTIVITY.

@bholmesdev bholmesdev force-pushed the edit/markdown-content-to-frontmatter branch from 4633fbd to da34151 Compare August 12, 2022 15:27
@bholmesdev bholmesdev merged commit 5129426 into main Aug 12, 2022
@bholmesdev bholmesdev deleted the edit/markdown-content-to-frontmatter branch August 12, 2022 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants