Skip to content

Add custom components to mdx integration guide #1426

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

Closed
wants to merge 1 commit into from
Closed

Add custom components to mdx integration guide #1426

wants to merge 1 commit into from

Conversation

kylebutts
Copy link
Contributor

What kind of changes does this PR include?

  • New or updated content

Description

@netlify
Copy link

netlify bot commented Aug 29, 2022

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit b6eea69
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/630c0fdc8127f500080733d7
😎 Deploy Preview https://deploy-preview-1426--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.

Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

Thanks so much for this @kylebutts, great work! Though, the integrations-guide files are generated from their READMEs in the main Astro repo, so you will have to make the PR there instead: https://github.com/withastro/astro/blob/main/packages/integrations/mdx/README.md

export const components = { blockquote: Blockquote };
```

The advantage of this is it allows for the simplicity of writing in markdown without having to write the custom component or writing a remark/rehype plugin. A full list of components that can have custom components is on the [MDX website]https://mdxjs.com/table-of-components/).
Copy link
Member

Choose a reason for hiding this comment

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

Just a small syntax issue here

Suggested change
The advantage of this is it allows for the simplicity of writing in markdown without having to write the custom component or writing a remark/rehype plugin. A full list of components that can have custom components is on the [MDX website]https://mdxjs.com/table-of-components/).
The advantage of this is it allows for the simplicity of writing in markdown without having to write the custom component or writing a remark/rehype plugin. A full list of components that can have custom components is on the [MDX website](https://mdxjs.com/table-of-components/).

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.

[md/mdx] components export for mdx in integration guide
2 participants