3.6 KiB
Storybook Docs Theming
Storybook Docs is themable! There are three different levels of theming, just to keep things interesting:
Storybook theming
Storybook theming is the recommended way to theme your docs. If you update your storybook theme according to the documentation, Storybook Docs should adapt in reasonable ways.
In the documentation it will say you can theme storybook in
manager.js, That's a newer more optimal way to theme storybook, but it's currently incompatible with docs.We're working on making it compatible in 6.0.0, so for now use the method described below.
Here's how to change your docs (and Storybook) to the dark theme, by modifying .storybook/preview.js:
import { addParameters } from '@storybook/react';
import { themes } from '@storybook/theming';
addParameters({
options: {
theme: themes.dark,
},
});
CSS escape hatches
The Storybook theme API is narrow by design. If you want to have fine-grained control over the CSS, all of the Docs components are tagged with class names to make this possible. This is advanced usage: use at your own risk.
The classes correspond to markdown elements (e.g. sbdocs-title, sbdocs-subtitle, sbdocs-p, etc.) to UI elements on the page (e.g. sbdocs-container, sbdocs-content, etc.). To see the currently available classes, use "inspect element" in your browser.
You can style these classes in .storybook/preview-head.html. For example, here's how to make the content wider for UHD displays:
<style>
.sbdocs.sbdocs-content {
max-width: 1440px;
}
</style>
NOTE: All of these elements also have the
sbdocsclass, which is an idiomatic way of increasing the CSS specificity so you don't have to use!important.
MDX component overrides
If you're using MDX, there's one more level of themability. MDX allows you to completely override the components that are rendered from markdown using a components parameter. This is an advanced usage that we don't officially support in Storybook, but it's a powerful mechanism if you need it.
Here's how you might insert a custom code renderer for code blocks on the page, in .storybook/preview.js:
import { addParameters } from '@storybook/react';
import { CodeBlock } from './CodeBlock';
addParameters({
docs: {
components: {
code: CodeBlock,
},
},
});
You can even override a Storybook block component.
Here's how you might insert a custom <Preview /> block:
import { MyPreview } from './MyPreview';
addParameters({
docs: {
components: {
Preview: MyPreview,
},
},
});