Skip to content

feat: custom doc-layout components#1611

Merged
Timeless0911 merged 5 commits intoweb-infra-dev:mainfrom
ap0nia:custom-doc-layout-components
Nov 20, 2024
Merged

feat: custom doc-layout components#1611
Timeless0911 merged 5 commits intoweb-infra-dev:mainfrom
ap0nia:custom-doc-layout-components

Conversation

@ap0nia
Copy link
Copy Markdown
Contributor

@ap0nia ap0nia commented Nov 20, 2024

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

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

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Nov 20, 2024

CLA assistant check
All committers have signed the CLA.

@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 20, 2024

Deploy Preview for aquamarine-blini-95325f ready!

Name Link
🔨 Latest commit 553f5e3
🔍 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
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.

Comment thread packages/document/docs/en/guide/advanced/custom-theme.mdx
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