Skip to content

Update dependency mui-markdown to v3 - #98

Open
renovate[bot] wants to merge 1 commit into
masterfrom
renovate/mui-markdown-3.x
Open

Update dependency mui-markdown to v3#98
renovate[bot] wants to merge 1 commit into
masterfrom
renovate/mui-markdown-3.x

Conversation

@renovate

@renovate renovate Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Change Age Confidence
mui-markdown (source) ^1.2.5^3.0.0 age confidence

Release Notes

HPouyanmehr/mui-markdown (mui-markdown)

v3.0.1

Compare Source

v3.0.0

Compare Source

⚠️ Breaking changes
  • markdown-to-jsx peer dependency is now >=9.0.0 (was >=7.0.0). If your app pins markdown-to-jsx v7 or v8, you must upgrade it alongside mui-markdown. mui-markdown now imports from the markdown-to-jsx/react entry point (the root React export is deprecated upstream and will be removed in markdown-to-jsx v10).
  • Raw HTML handling changed (upstream markdown-to-jsx v9 security fix). Dangerous HTML tags in markdown content (<script>, <iframe>, <object>, <embed>, <style>, <textarea>, <title>, <xmp>, <plaintext>, <noembed>, <noframes>) are now escaped and rendered as text instead of being passed through. javascript:/vbscript:/malicious data: URLs are also sanitized. Benign HTML (e.g. <span style="...">) still passes through.
    • What to check: if you intentionally render such tags from trusted markdown, pass options={{ tagfilter: false }} to restore the old behavior. For untrusted content, keep the new default.
  • Inline formatting no longer spans line breaks (upstream CommonMark compliance). *text\nacross lines* now renders literal asterisks. Keep emphasis on one line or use HTML tags.
  • GFM task list items now render with a MUI Checkbox instead of a raw <input type="checkbox">. Override the input key in overrides if you want different rendering.
  • Note: markdown-to-jsx v9 requires React >= 16; mui-markdown's own peer range remains react >= 17.
✨ New features (opt-in, no behavior change unless enabled)
  • Table of contents extraction: new extractHeadings(markdown, options?) export returns { text, level, id }[] where id matches the anchor ids MuiMarkdown renders. Build your own TOC component from it — nothing is auto-rendered. See the README example.
  • Math support (KaTeX): new enableMath prop plus MathBlock component (exported from mui-markdown/client) render ```math fenced blocks with KaTeX. katex is an optional dependency and is loaded lazily on the client, so bundle size is unchanged for non-users. Configure via katexOptions. Currently block math only (no inline $...$).
  • Footnotes ([^1]) are now rendered natively by markdown-to-jsx v9, with mui-markdown's MUI Link styling applied to references.

🔧 Fixes / internal

  • Restored bare code-fence flags (```js copiable hideLineNumbers) which markdown-to-jsx v9 stopped passing to renderers; mui-markdown now recovers them from the AST infoString, so all documented Enhanced Code Block features keep working.
  • Code fence attribute casing is preserved in v9 (hideLineNumbers is no longer lowercased); both spellings are accepted.
  • Added an automated test suite (vitest) covering overrides, options, code block features, mermaid routing, math routing, task lists, footnotes, HTML escaping, and extractHeadings.
  • Dev dependency updates; npm audit is clean (@rollup/plugin-terser bumped to 1.x for the serialize-javascript advisory). @rollup/plugin-typescript is pinned to 12.1.2 — 12.3.0 breaks the build (declaration path validation).
  • MUI note: @mui/material latest major is now 9.x; the peer range >=5.0.0 already allows it, and the library is built/tested against 7.x. No peer change made.
Migration from 2.x
  1. Upgrade the peer: npm i markdown-to-jsx@^9.
  2. If you relied on rendering <script>/<iframe>-class tags from markdown, add options={{ tagfilter: false }} (trusted content only).
  3. If you relied on emphasis spanning multiple lines, put it on one line.
  4. If you override pre/code or use custom renderRule, re-test code blocks: v9 emits both language-x and lang-x classes.
  5. Everything else — component API, overrides, getOverrides, MDX helpers, mermaid, syntax highlighting — is unchanged.

v2.1.1

Compare Source

  • See git history (no changelog was kept before 3.0.0).

v2.1.0

Compare Source

Enhanced code blocks with syntax highlighting features, copy functionality, and extensive customization options.

  • Line Highlighting - Highlight specific lines with customizable colors
  • Code Diffs - Show removed/inserted lines with visual indicators
  • File Names - Display file path/name above code blocks with custom styling
  • Copy Button - One-click code copying with custom component support
  • Hide Line Numbers - Toggle line number visibility per block or globally
  • Theme Integration - Full MUI theme support for all colors and styles
  • Custom Components - Replace file icon, copy button, and file name with custom components

For detailed usage examples, see the README.

v2.0.5

Compare Source

Fix #​37

Full Changelog: HPouyanmehr/mui-markdown@v2.0.4...v2.0.5

v2.0.4

Compare Source

Fix #​37

Full Changelog: HPouyanmehr/mui-markdown@v2.0.3...v2.0.4

v2.0.3

Compare Source

Fix #​35

Table scrollbar is now optional; enable it with the customTableScrollbar key.
Note: Enabling it makes the table component client-side.

Full Changelog: HPouyanmehr/mui-markdown@v2.0.2...v2.0.3

v2.0.2

Compare Source

v2.0.1

Compare Source

  • Fix: Separate the client-side mermaid Diagram component

Full Changelog: HPouyanmehr/mui-markdown@v2.0.0...v2.0.1

v2.0.0

Compare Source

What's Changed

New Contributors

Full Changelog: HPouyanmehr/mui-markdown@v1.2.6...v2.0.0

v1.2.6

Compare Source

Add support for MUI v7 (#​31)

Full Changelog: HPouyanmehr/mui-markdown@v1.2.5...v1.2.6


Configuration

📅 Schedule: (UTC)

  • Branch creation
    • At any time (no schedule defined)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate
renovate Bot force-pushed the renovate/mui-markdown-3.x branch 3 times, most recently from f84984b to deae94a Compare July 24, 2026 12:09
@renovate
renovate Bot force-pushed the renovate/mui-markdown-3.x branch from deae94a to 2826adc Compare July 30, 2026 16:46
@renovate
renovate Bot force-pushed the renovate/mui-markdown-3.x branch from 2826adc to 9de805c Compare August 12, 2026 03:48
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.

0 participants