-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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: using targetted styles, not components to style MDX #19958
Merged
JReinhold
merged 13 commits into
next
from
tom/sb-996-resolve-css-issue-with-introduction
Dec 2, 2022
Merged
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
c0eef1a
POC: using targetted styles, not components to style MDX
tmeasday feae2e3
Merge branch 'next' into tom/sb-996-resolve-css-issue-with-introduction
ndelangen 23d3452
fix types
ndelangen b0fa9d7
migrate all custom component styles to global styles
JReinhold 5e4226d
Move styles to DocsContent, add .sb-story to Story block
JReinhold 5291762
build Unstyled block, prettier ignore mdx
JReinhold b3baca1
fix docsPage stories getting global styles
JReinhold 2820c5a
make Description not use styled components
JReinhold 7d7777a
cleanup Unstyled docs
JReinhold 3c3ccba
migration notes.
JReinhold 7e2d3f4
Merge branch 'next' into tom/sb-996-resolve-css-issue-with-introduction
JReinhold 29587c9
fix Description code blocks, add docsStyles parameter to SBUI
JReinhold f02fdb7
Merge branch 'next' into tom/sb-996-resolve-css-issue-with-introduction
JReinhold File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*.mdx |
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
import { Unstyled } from './Unstyled.tsx'; | ||
import StoriesMeta, {Undefined} from '../controls/Boolean.stories'; | ||
import { Story } from '@storybook/blocks'; | ||
import { Meta } from '@storybook/blocks'; | ||
|
||
<Story of={Undefined} meta={StoriesMeta}/> | ||
|
||
# The Unstyled Block | ||
|
||
By default most elements in docs have a few default styles applied to ensure the docs look good. This is achieved by applying default styles to most elements like `h1`, `p`, etc.. | ||
However sometimes you might want some of your content to not have these styles applied, this is where the `Unstyled` block is useful. Wrap any content you want in the `Unstyled` block to remove the default styles: | ||
|
||
```md | ||
import { Unstyled } from '@storybook/blocks'; | ||
|
||
> This block quote will be styled | ||
|
||
... and so will this paragraph. | ||
|
||
<Unstyled> | ||
> This block quote will not be styled | ||
|
||
... neither will this paragraph, nor the following component: | ||
<MyCustomComponent /> | ||
</Unstyled> | ||
``` | ||
|
||
Yields: | ||
|
||
> This block quote will be styled | ||
|
||
... and so will this paragraph. | ||
|
||
<Unstyled> | ||
> This block quote will not be styled | ||
|
||
... neither will this paragraph, nor the following component: | ||
</Unstyled> | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
import React from 'react'; | ||
|
||
export const Unstyled: React.FC = (props) => <div {...props} className="sb-unstyled" />; |
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
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
Oops, something went wrong.
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.
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.
@jonniebigodes if you have feedback for this documentation, let me know.