search

mui / material-ui

Material UI: Comprehensive React component library that implements Google's Material Design. Free forever.
https://mui.com/material-ui/
MIT License
93.51k stars 32.19k forks source link

[docs-infra] IntelliSense (quick info) on code previews #41295

Open oliviertassinari opened 7 months ago

oliviertassinari commented 7 months ago

Summary

We could make it possible, like in VS Code, for developers to have access to quick info on our docs editors.

Examples

Reference points:

  1. Ariakit https://twitter.com/diegohaz/status/1681277579725090816
Screenshot 2023-07-19 at 18 53 56

It can be tested on https://ariakit.org/guide/getting-started.

  1. Nuxt, Another one in the same line of thought: https://nuxt.com/docs/getting-started/seo-meta

https://github.com/mui/material-ui/assets/3165635/48fdd88a-d516-41a6-9c64-92d1183ee0ae

But poor execution, it's better UX without it.

  1. VS Code, it feels like approaching this like VS Code could be a great UX, e.g.
Screenshot 2023-07-19 at 18 57 35

Motivation

No response

Search keywords: IntelliSense quick info

alexfauquette commented 6 months ago

Somewhat related: Shiki Twoslash From https://github.com/mui/material-ui/pull/40901#issuecomment-1994252559