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] Improve right to left guide #27713

Merged
merged 7 commits into from Aug 16, 2021

Conversation

mnajdova
Copy link
Member

@mnajdova mnajdova commented Aug 12, 2021

Closes #27701

Changes done:

  • restructures the content of the sections to add instructions for emotion and styled-components first
  • adds stylis in the instruction for the installation of the stylis-plugin-rtl (I've spent an hour debugging [docs] RTL not working when stylis is not installed #27701 before I realized that stylis is missing in the dependencies)

Preview https://deploy-preview-27713--material-ui.netlify.app/guides/right-to-left/

@mui-pr-bot
Copy link

mui-pr-bot commented Aug 12, 2021

No bundle size changes (experimental)

Generated by 🚫 dangerJS against 45638e6

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Aug 12, 2021
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
docs/src/pages/guides/right-to-left/right-to-left.md Outdated Show resolved Hide resolved
docs/src/pages/guides/right-to-left/right-to-left.md Outdated Show resolved Hide resolved
docs/src/pages/guides/right-to-left/right-to-left.md Outdated Show resolved Hide resolved
docs/src/pages/guides/right-to-left/right-to-left.md Outdated Show resolved Hide resolved
docs/src/pages/guides/right-to-left/right-to-left.md Outdated Show resolved Hide resolved
mnajdova and others added 3 commits August 13, 2021 13:11
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
@mnajdova mnajdova requested a review from eps1lon August 13, 2021 12:28

{{"demo": "pages/guides/right-to-left/RtlOptOut.js", "hideEditButton": true}}
{{"demo": "pages/guides/right-to-left/RtlOptOutStylis.js", "hideToolbar": true}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One detail, if we only want to disable the preview and keep the toolbar, we could use "defaultCodeOpen": false.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of this demo is irrelevant. It really is just about noflip usage.

@mnajdova mnajdova merged commit 2a025b2 into mui:next Aug 16, 2021
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

Successfully merging this pull request may close these issues.

[docs] RTL not working when stylis is not installed
4 participants