-
-
Notifications
You must be signed in to change notification settings - Fork 32.8k
[docs-infra] Fix markdown generation script to find correct files #46954
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Netlify deploy previewhttps://deploy-preview-46954--material-ui.netlify.app/ Bundle size report
|
packages/mui-docs/src/ComponentLinkHeader/ComponentLinkHeader.tsx
Outdated
Show resolved
Hide resolved
docs/data/material/components/use-media-query/use-media-query.md
Outdated
Show resolved
Hide resolved
14b3c08 to
8c33474
Compare
| if (!projectSettings.pagesManifestPath) { | ||
| return []; | ||
| } | ||
| const pagesContent = fs.readFileSync(projectSettings.pagesManifestPath, 'utf-8'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Janpot I have updated to use pages as source of truth to generate markdown files for non component.
Janpot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
closes mui/mui-public#717
Root cause
The issue was that the Typography component's documentation wasn't being generated because:
Others
Fix the logic for non component markdown files to use
pages.tsas a source of truth to find markdown pages.This fix will ensure that the url has
.mdwithout manual selection.Result
All valid now (from the deploy preview):
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-transfer-list.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-typography.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-popper.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-badge.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-link.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-use-media-query.md
https://deploy-preview-46954--material-ui.netlify.app/material-ui/react-paper.md