-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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-infra] Add code block header classes #41487
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danilo-leal
added
design
This is about UI or UX design, please involve a designer
scope: docs-infra
Specific to the docs-infra product
labels
Mar 13, 2024
Netlify deploy previewhttps://deploy-preview-41487--material-ui.netlify.app/ Bundle size report |
siriwatknp
reviewed
Mar 14, 2024
siriwatknp
reviewed
Mar 14, 2024
@danilo-leal Here is my proposal to follow Docusaurus. |
siriwatknp
approved these changes
Mar 14, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Thanks for starting this! I almost forgot about it, sorry for the delay.
@danilo-leal feel free to bypass CI and merge if you want. |
This was referenced May 19, 2024
This was referenced Jun 5, 2024
This was referenced Jun 5, 2024
This was referenced Jun 5, 2024
This was referenced Jun 5, 2024
This was referenced Jun 6, 2024
This was referenced Jun 6, 2024
This was referenced Jun 15, 2024
This was referenced Jul 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
design
This is about UI or UX design, please involve a designer
scope: docs-infra
Specific to the docs-infra product
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An attempt at adding headers to code blocks that are usually useful when we want to display the file name of a certain code snippet. I have a feeling this is not the most efficient/elegant way to do 😅 I still wanted to take a shot at pulling this off, but there might be better ways where the DX is similar to the custom
<codeblocks>
component, and cleaner. Possibly something like:Closes #38381 (or not — in any case, let me know! I'm happy to ditch this PR if we don't think it's useful.)
Preview: https://deploy-preview-41487--material-ui.netlify.app/experiments/docs/codeblock/
In the ideal world, we'd have a solution that would appear like a breadcrumb, displaying the full path from where a code snippet belongs. This is not covered in this PR and another reason why this is potentially not the best solution 😬