Skip to content

docs: polish the use-mdx/components#2425

Merged
SoonIter merged 2 commits intomainfrom
syt/fix-typo
Jul 29, 2025
Merged

docs: polish the use-mdx/components#2425
SoonIter merged 2 commits intomainfrom
syt/fix-typo

Conversation

@SoonIter
Copy link
Copy Markdown
Member

Summary

docs: polish the use-mdx/components

Related Issue

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings July 29, 2025 08:11
@netlify
Copy link
Copy Markdown

netlify bot commented Jul 29, 2025

Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit ee43c75
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/6888824435d88c0008d4484d
😎 Deploy Preview https://deploy-preview-2425--rspress-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify bot commented Jul 29, 2025

Deploy Preview for rspress ready!

Name Link
🔨 Latest commit ee43c75
🔍 Latest deploy log https://app.netlify.com/projects/rspress/deploys/688882445f7e3500083b4de5
😎 Deploy Preview https://deploy-preview-2425--rspress.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90 (🟢 up 13 from production)
Accessibility: 97 (no change from production)
Best Practices: 92 (🟢 up 9 from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR polishes the documentation for using MDX components by clarifying the routing convention and fixing syntax issues in code examples.

  • Added clarification about the route.excludeConvention configuration for files excluded from routing
  • Fixed syntax errors in TypeScript component export examples
  • Added import statement examples for components from adjacent directories

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
packages/document/docs/zh/guide/basic/use-mdx/components.mdx Updated Chinese documentation with routing convention clarification and fixed component export syntax
packages/document/docs/en/guide/basic/use-mdx/components.mdx Updated English documentation with routing convention clarification and fixed component export syntax

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SoonIter SoonIter enabled auto-merge (squash) July 29, 2025 08:12
@SoonIter SoonIter requested a review from Timeless0911 July 29, 2025 08:16
@SoonIter SoonIter merged commit 7e1e932 into main Jul 29, 2025
11 checks passed
@SoonIter SoonIter deleted the syt/fix-typo branch July 29, 2025 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants