Skip to content

Conversation

@ChristianMurphy
Copy link
Member

With many issues it can be difficult to get a clear understanding of what is broken, from a code sample.
Samples are often incomplete, and may not have all the context needed to replicate and understand the issue.
Codesandbox (or another sandbox tool) can help by providing a clean and shareable environment to demonstrate an issue.

@ChristianMurphy ChristianMurphy requested review from a team November 3, 2020 22:08
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Nice!

Added some text to clarify what the sandbox does, and what it uses.

Also: it would be good to steer folks to use unified -> remark-parse -> remark plugins -> remark-rehype -> rehype-raw when needed -> rehype plugins -> rehype-stringify.
No hard data for it but I’m feeling like a bunch can be better done at the rehype level

@ChristianMurphy ChristianMurphy added 👩‍⚕ area/health This affects community 💬 type/discussion This is a request for comments 📚 area/docs This affects documentation labels Nov 4, 2020
also adds a starter for remark with rehype

Co-authored-by: Titus Wormer <[email protected]>
@ChristianMurphy ChristianMurphy merged commit c669bbe into remarkjs:main Nov 4, 2020
@ChristianMurphy ChristianMurphy deleted the docs/add-codesandbox-start branch November 4, 2020 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 area/docs This affects documentation 👩‍⚕ area/health This affects community 💬 type/discussion This is a request for comments

Development

Successfully merging this pull request may close these issues.

3 participants