feat(packages/ui): add rspress rendering plugins#47
Conversation
…ees, math, and supersub Register rspress-plugin-mermaid, rspress-plugin-file-tree, rspress-plugin-katex, and rspress-plugin-supersub in the Rspress config so that markdown code blocks and syntax render correctly on the built site. Co-Authored-By: Claude <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: f0a5076 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR adds Rspress rendering plugins (mermaid, file-tree, KaTeX, and superscript/subscript) to the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
contributing/standards/documentation/diagrams.md (1)
29-29:⚠️ Potential issue | 🟡 MinorMinor inconsistency: table still references "ASCII".
The diagram type table on line 29 still lists "File tree (ASCII)" but the guidance now recommends using
```treeblocks (which are not ASCII diagrams but plugin-rendered components). Consider updating this to "File tree (Tree block)" for consistency with the renamed section.📝 Suggested fix
-| Directory layouts | File tree (ASCII) | Repository structure | +| Directory layouts | File tree (Tree block) | Repository structure |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@contributing/standards/documentation/diagrams.md` at line 29, Update the table header entry that currently reads "File tree (ASCII)" to "File tree (Tree block)" so the "Directory layouts | File tree (ASCII) | Repository structure" row matches the renamed section; edit the table cell text to "File tree (Tree block)" wherever that table row appears to keep terminology consistent.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@contributing/standards/documentation/diagrams.md`:
- Line 29: Update the table header entry that currently reads "File tree
(ASCII)" to "File tree (Tree block)" so the "Directory layouts | File tree
(ASCII) | Repository structure" row matches the renamed section; edit the table
cell text to "File tree (Tree block)" wherever that table row appears to keep
terminology consistent.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c4958db8-15b8-484a-b16b-fdde3ba080f1
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (4)
.changeset/add-rspress-plugins.mdcontributing/standards/documentation/diagrams.mdpackages/ui/package.jsonpackages/ui/src/config.ts
Co-Authored-By: Claude <noreply@anthropic.com>
rspress-plugin-devkit@1.0.0 ships as ESM ("type": "module") but its
internal imports omit .js extensions, which Node.js ESM resolution
rejects. Patch all relative imports to include explicit .js extensions.
Co-Authored-By: Claude <noreply@anthropic.com>
Summary
@zpress/uifor full markdown rendering support:rspress-plugin-mermaid— renders```mermaiddiagrams (flowcharts, sequence, ER)rspress-plugin-file-tree— renders```treeblocks as interactive collapsible treesrspress-plugin-supersub—^superscript^/~subscript~syntaxrspress-plugin-katex—$inline$/$$block$$math formulas via KaTeXtreeblock syntaxChanges
packages/ui/src/config.ts— import and register all four pluginspackages/ui/package.json— add plugin dependenciescontributing/standards/documentation/diagrams.md— add "Rendering Plugins" section, update file tree guidance to use```treeblocks, add plugin links to ResourcesTest plan
pnpm typecheckpasses (16/16 tasks)pnpm testpasses inpackages/ui(9/9 tests)```treeblocks render as collapsible trees$math$and^super^/~sub~render correctlySummary by CodeRabbit
New Features
Documentation