search

mui / base-ui

Base UI is an open-source library of accessible, unstyled UI components for React.
MIT License
291 stars 47 forks source link

[docs-infra] Add mdx support to vale lint #769

Closed oliviertassinari closed 3 weeks ago

oliviertassinari commented 4 weeks ago

A quick fix for a regression that I noticed while fixing https://github.com/mui/material-ui/pull/44277. We were no longer linting the docs. This got broken with #538.

Ideally, we could use https://github.com/errata-ai/vale/issues/841, but it's not there. Instead, there are a bunch of examples online on how this can be done https://github.com/search?q=%5Bformats%5D+mdx+%3D+md&type=code.

We will need to propagate this to the other repositories. But unclear if we should do it just yet, we might want to wait. Point 20. of https://github.com/mui/base-ui/issues/588 doesn't make it super clear that MDX is compatible with a great UX for developers. I imagine that it's solvable, but it's it's not it seems to mean that we need to remove MDX and go back to the previous approach that yields better performance.

mui-bot commented 4 weeks ago

Netlify deploy preview

https://deploy-preview-769--base-ui.netlify.app/

Generated by :no_entry_sign: dangerJS against b18d8d78f13d04ba381ce3fd667a8e03dcad98d3

michaldudak commented 4 weeks ago

Point 20. of https://github.com/mui/base-ui/issues/588 doesn't make it super clear that MDX is compatible with a great UX for developers.

This isn't caused by MDX, but the Next.js App Router.