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] Update Fontsource installation instructions #22431

Merged
merged 1 commit into from
Aug 31, 2020

Conversation

ayuhito
Copy link
Contributor

@ayuhito ayuhito commented Aug 31, 2020

Fontsource went through a breaking change to make the library more versatile for international users.

This update aims to clean up all the old documentation to be more reflective of that and easier to understand for the reader. Also, the repository moved to an org so the main link was edited to not waste a redirect.

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Aug 31, 2020
@mui-pr-bot
Copy link

Details of bundle changes

Generated by 🚫 dangerJS against 0d31e80

@oliviertassinari oliviertassinari merged commit 99a4f8c into mui:next Aug 31, 2020
@ayuhito ayuhito deleted the fontsource-update branch August 31, 2020 16:04
@vhakulinen
Copy link

Shouldn't this be mentioned in the 4.x docs too? The 4.x mentions this:

⚠️ Be careful when using this approach. Make sure your bundler doesn't eager load all the font variations (100/300/400/500/700/900, italic/regular, SVG/woff). Fontsource can be configured to load specific subsets, weights and styles. Inlining all the font files can significantly increase the size of your bundle. Material-UI default typography configuration only relies on 300, 400, 500, and 700 font weights.

I think that the 5.x docs helps the user much better that 4.x on this topic.

@oliviertassinari
Copy link
Member

All ongoing work is on v5. If we cherry-pick this commit to v4, we would want to cherry-pick a lot more for consistency in the strategy. If you won't bother about breaking changes, you can use v5-alpha. We aim for the same level of quality as for a stable release.

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.

4 participants