web-infra-dev / rspress

🦀💨 A fast Rspack-based static site generator.
https://rspress.dev
MIT License
1.46k stars 135 forks source link

feat: custom doc-layout components #1611

Closed ap0nia closed 2 days ago

ap0nia commented 2 days ago

Summary

The DocLayout uses internal components to render MDX nodes. There is no documented way (as far as I can tell) to override these nodes without providing an entirely custom DocLayout component altogether.

To address this, allow the user to provide components to the Layout component. In the future, maybe the DocLayout could be extended to handle arbitrary nodes as well.

Related Issue

Related to #1362 because this feature will allow the user to override and customize known MDX nodes.

Checklist

CLAassistant commented 2 days ago

CLA assistant check
All committers have signed the CLA.

netlify[bot] commented 2 days ago

Deploy Preview for aquamarine-blini-95325f ready!

Name Link
Latest commit 553f5e3fead69bf895d0b2dc10ca4b7437902e0e
Latest deploy log https://app.netlify.com/sites/aquamarine-blini-95325f/deploys/673d9656d96c2b00084d70d1
Deploy Preview https://deploy-preview-1611--aquamarine-blini-95325f.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
1 paths audited
Performance: 93 (no change from production)
Accessibility: 97 (no change from production)
Best Practices: 92 (no change 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 site configuration.