replace old blockquotes with admonitions, add codeblocks titles (part 1) #3170
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
✅ Deploy Preview for react-native ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Simek
force-pushed
the
admonitions-and-titled-codeblock-part1
branch
from
aa76f5d
to
4593cf2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
This PR is the first in series, in which I going to replace legacy styling and workarounds with new Docusuaurs features (I have decided to split the changes into few PR so the amount of changes won't be overwhelming for the reviewers).
How
The first change is to replace the the old
blockquoteblocks which were used for emphasising the content before the Admonitions was a thing. I have chosen the styling and added a custom tile (if needed) based on the current "notes" content.Ideally, we want to get rid of all
blockquotelike that, to be able to use the component for the regular quotes, but this might take a longer while, so ATM I have put my focus on the unversioned docs.The second change is that CodeBlock now supports
titleparameter, and in this PR I have replaced names in comments by this parameter for the affected CodeBlocks.Test plan
The changes have been tested by running the docs website locally.