fix(v2): make code blocks more standalone #4315
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
|
[V1] Deploy preview success Built with commit 669332b |
|
Size Change: +55 B (0%) Total Size: 532 kB
ℹ️ View Unchanged
|
|
Deploy preview for docusaurus-2 ready! Built with commit 669332b |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4315--docusaurus-2.netlify.app/classic/ |
lex111
force-pushed
the
lex111/code-blocks-drop-mdx-container
branch
from
0fd2f09
to
711b78b
Compare
lex111
changed the title
lex111
commented
Feb 28, 2021
| @@ -25,7 +23,10 @@ const MDXComponents: MDXComponentsObject = { | |||
| return children; | |||
| }, | |||
| a: (props) => <Link {...props} />, | |||
| pre: (props) => <div className={styles.mdxCodeBlock} {...props} />, | |||
| pre: (props: any) => { | |||
There was a problem hiding this comment.
@slorber here, as usual, I need your help with correct typing 🙃
There was a problem hiding this comment.
hmmm I don't find a very good way to type this, but I don't think this is a big deal anyway
# Conflicts: # packages/docusaurus-theme-live-codeblock/src/theme/Playground/index.js # website/src/pages/examples/markdownPageExample.md
|
LGTM! |
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.
Motivation
Right now, when using
CodeBlockcomponent directly in documents, the font size will be larger than it should be.For example at https://v2.docusaurus.io/docs/next/i18n/crowdin#example-configuration
CodeBlockI propose remove MDX wrapper around code blocks, and move its styles in
CodeBlockcomponent itself. This way, no matter how you use code blocks, they will look the same.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Compare results:
Current - https://v2.docusaurus.io/docs/next/i18n/crowdin#example-configuration
Preview - https://deploy-preview-4315--docusaurus-2.netlify.app/classic/docs/next/i18n/crowdin#example-configuration
To make sure that the new changes did not break anything, in the example page I added several code blocks created in different ways: https://deploy-preview-4315--docusaurus-2.netlify.app/classic/examples/markdownPageExample#code-block-test
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)