mui-toolpad
mui-toolpad copied to clipboard
Generate API docs for Toolpad Core
Generate API docs for Toolpad Core - first the proptypes must be generated with pnpm proptypes
and then API docs built with pnpm docs:build:api
.
Restructured the documentation a bit kind of just to be more like the other MUI libraries I was taking the scripts from and what these scripts expect, but it's all for discussion of course!
API links from component pages are broken - if this PR looks good I think we can fix it here in the MUI monorepo: https://github.com/mui/material-ui/blob/next/packages/markdown/prepareMarkdown.js
API Page: https://deploy-preview-3536--mui-toolpad-docs.netlify.app/toolpad/core/api/app-provider/
This should be good when the PRs this is based on are merged.
I also think we're gonna have to change this in the MUI monorepo to fix API URLs in component pages: https://github.com/mui/material-ui/blob/next/packages/markdown/prepareMarkdown.js But waiting for further review first.
TODO:
- [x] Fix proptypes generation
- [x] Do not list demos in callout for every component with API links
Thanks! I removed an alias as it broke the demo formatter.