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

Create mdx playground #23

Draft
wants to merge 7 commits into
base: next
Choose a base branch
from
Draft

Create mdx playground #23

wants to merge 7 commits into from

Conversation

hs-saunved
Copy link
Collaborator

This is a work-in-progress to help folks preview changes easily before adding them to GitHub. It's intended to help avoid setting up the entire development environment as much as possible.

+ We need to downgrade the React version because @mdx/runtime
  requires React v16. This has no impact on our Docusaurus output
+ Since the playground requires node polyfills (due to MDX runtime)
  this is a must for enabling those deps
+ This plugin will be disabled for production builds to avoid
  bloating the final output
…ments

+ Margin, padding classes are enabled as spacing helpers
+ Since Tailwind doesn't include unused classes, we will have to
  add these during previews or development for a better
  playground experience
+ This is fully experimental, but it gives a good enough preview
  for most common use cases. Users should be able to use this
  to avoid local setups for making paragraph or even document-level
  changes
+ All forDocs plugins are injected into the MDX component's scope
  by default for an easier experience
+ This plugin will not load in our production environment to avoid
  bloating the final bundle
@vercel
Copy link

vercel bot commented Feb 2, 2023

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

Name Status Preview Comments Updated
helpshift-docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 2, 2023 at 8:58PM (UTC)

+ The MDX runtime module was not building properly with webpack
+ Had to go on a slightly lower level and use the MDX library directly
+ Handled some exception/error cases
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.

1 participant