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

chore(docs): fix console warnings, codesandbox builds #86

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

evwilkin
Copy link
Member

@evwilkin evwilkin commented Nov 21, 2024

Closes #11

This PR:

  • Updates example exports to be named exports to avoid console warnings (export const Example... vs. const Example .... export default Example)
    • These errors are thrown by our code in mdx-ast-to-mdx-hast.js which throws an error when the name of an exported example cannot be easily parsed.
    • See codesandbox.js for the supported example export naming conventions.
  • Fixes Codesandbox builds for examples as the default example exports were breaking those examples - named exports fixes this.
  • Updates the relative import of the realTestData.js file across examples to an absolute import path to fix an issue of the relative import breaking the Codesandbox examples.

Copy link
Contributor

@nicolethoen nicolethoen left a comment

Choose a reason for hiding this comment

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

Ran it locally and it all looks good! :)

@dlabaj dlabaj merged commit fdcecca into main Nov 25, 2024
7 checks passed
Copy link

github-actions bot commented Dec 4, 2024

🎉 This PR is included in version 6.1.0-prerelease.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

Bug - examples in docs causing build:docs warnings
3 participants