Skip to content
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

[docs] Framework setup guides for Base UI #18

Open
mj12albert opened this issue Apr 24, 2023 · 0 comments
Open

[docs] Framework setup guides for Base UI #18

mj12albert opened this issue Apr 24, 2023 · 0 comments
Assignees
Labels
docs Improvements or additions to the documentation

Comments

@mj12albert
Copy link
Member

mj12albert commented Apr 24, 2023

Extension of mui/material-ui#32979

Summary

I opened this issue to explore how the Base UI docs could dive deeper into the topic of "how to integrate Base UI with different things". Aside from CSS frameworks, we could provide guides on how to use Base with "web" frameworks (CRA, Vite, Next.js) to set up a more complete project.

This type of guide could complement our example repos well (mui/material-ui#36193), could help give them more visiblity and can maybe be positioned as a "How this example was made" guide for each one.

Here's a rough draft of a Base UI + Vite guide: https://deploy-preview-36918--material-ui.netlify.app/base/guides/vite/
⚠️ the content is a rough draft, not even seriously proof-read yet ⚠️

There are 3 separate sections for plain/module CSS, Tailwind, and MUI System – maybe we could use Tabs or similar to allow a reader to toggle between showing one of them at a time. (Or maybe this should be 3 separate guides).

Possible guides

  • vite
  • next.js
  • remix
  • gatsby
  • Redwood JS

Benchmarks

@mj12albert mj12albert self-assigned this Apr 24, 2023
@michaldudak michaldudak transferred this issue from mui/material-ui Feb 27, 2024
@michaldudak michaldudak added the docs Improvements or additions to the documentation label Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants