feat(theme/style)!: keep the html style be consistent with markdown syntax and .rp-not-doc escape hatch (#2579)
#2600
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ntax and `.rp-not-doc` escape hatch (#2579)
✅ Deploy Preview for rspress-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the theming system to unify HTML element styling between markdown syntax and HTML tags, introducing a new .rp-not-doc escape hatch for opting out of documentation styling.
- Consolidates styling by moving MDX component styles to a centralized SCSS file
- Introduces
.rp-docand.rp-not-docCSS classes for controlling documentation styling - Simplifies MDX component implementations by removing inline Tailwind classes
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/theme-default/src/styles/doc.scss | New centralized SCSS file containing all documentation element styles |
| packages/theme-default/src/layout/DocLayout/docComponents/*.tsx | Simplified component implementations removing Tailwind classes |
| website/docs/*/guide/basic/use-mdx/_escape-hatch.tsx | Updated example demonstrating new styling approach |
| packages/plugin-/static/global-components/.tsx | Added rp-not-doc class to plugin components |
| e2e/fixtures/theme-css/doc/prose/index.mdx | New test file demonstrating styling consistency |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Timeless0911
approved these changes
Sep 16, 2025
SoonIter
deleted the
syt/keep-html-style-to-be-consistent-with-markdown-syntax
branch
This was referenced Sep 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
feat(theme/style)!: keep the html style be consistent with markdown syntax and
.rp-not-docescape hatch (#2579)Related Issue
#2569
Checklist