Skip to content

docs: Add comprehensive rehype-raw plugin documentation with TypeScript #914

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

amansachdev
Copy link

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.

…pt support

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

- 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 user confusion reported in issues remarkjs#696 and remarkjs#765 about plugin usage.
@github-actions github-actions bot added the 👋 phase/new Post is being triaged automatically label Jun 11, 2025
Copy link

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

Copy link

codecov bot commented Jun 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👋 phase/new Post is being triaged automatically
Development

Successfully merging this pull request may close these issues.

1 participant