react-markdown icon indicating copy to clipboard operation
react-markdown copied to clipboard

docs: Add comprehensive rehype-raw plugin documentation with TypeScript

Open amansachdev opened this issue 7 months ago • 2 comments

This PR adds missing documentation for using the rehype-raw plugin with react-markdown, addressing common issues faced by developers:

  • Clarifies the difference between remarkPlugins and rehypePlugins
  • Provides TypeScript-specific guidance for type errors
  • Adds security considerations when using rehype-raw
  • Includes complete working examples

This addresses multiple user reports in issues #696 and #765 about confusion with plugin usage.

amansachdev avatar Jun 11 '25 07:06 amansachdev

Hi! It seems you removed the template which we require. Here are our templates (pick the one you want to use and click *raw* to see its source):

I won’t send you any further notifications about this, but I’ll keep on updating this comment, and hide it when done!

Thanks, — bb

github-actions[bot] avatar Jun 11 '25 07:06 github-actions[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (fda7fa5) to head (2a8bc4d).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #914   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines         1743      1743           
  Branches       123       123           
=========================================
  Hits          1743      1743           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Jun 11 '25 09:06 codecov[bot]