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

docs: update ContentRenderer custom components #2433

Merged
merged 2 commits into from Nov 22, 2023
Merged

Conversation

lukszy
Copy link
Contributor

@lukszy lukszy commented Nov 12, 2023

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Updated the docs for ContentRenderer as it was misleading. When using custom components in a MD file, user should pass a map which should be

const components = {
  'custom-component': CustomComponentObject,
}

Hope that help

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Updated the docs for ContentRenderer as it was misleading, instead of passing a string for custom components it needs the components object.

Hope that help
Copy link

nuxt-studio bot commented Nov 12, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Content Edit on Studio β†—οΈŽ View Live Preview 4f6a40f

@farnabaz farnabaz merged commit e99967d into nuxt:main Nov 22, 2023
1 check passed
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.

None yet

2 participants