Skip to content

feat(markdoc): Document using custom image components in Markdoc#6829

Merged
sarah11918 merged 7 commits into
mainfrom
feat/markdoc-images
Feb 12, 2024
Merged

feat(markdoc): Document using custom image components in Markdoc#6829
sarah11918 merged 7 commits into
mainfrom
feat/markdoc-images

Conversation

@Princesseuh
Copy link
Copy Markdown
Member

@Princesseuh Princesseuh commented Feb 8, 2024

Description (required)

Documentation for withastro/astro#9958

(For @astrojs/markdoc v0.9 minor release)

@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Feb 12, 2024 3:06pm
1 Ignored Deployment
Name Status Preview Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Feb 12, 2024 3:06pm

@Princesseuh Princesseuh added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Feb 8, 2024
@sarah11918 sarah11918 added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Feb 8, 2024
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

It's OK if you hate this and want to revert, but I took a shot at making these a bit more "instruction-y" and adding context about the why and when to do this, because it's a really cool thing!

No rush to look at this, and I haven't totally proofread, just wanted to restructure it a bit to see what we thought.

P.S. One change I made in each case is that I showed the Astro component first, then then the config. It felt weird to be configuring something that didn't yet exist, and that we didn't know what it was. I do acknowledge that this separates the Astro component from the Markdoc where you pass it the props though, so I get if it feels weird to you that the config is in the middle of those two things.

Anyway, see what you think of something like this!

@Princesseuh
Copy link
Copy Markdown
Member Author

Yes, this looks great to me!

Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/markdoc.mdx
@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Feb 12, 2024
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

MMM... Making Markdoc Marvelous!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants