storybook-addon-docusaurus
🦖 一个用于辅助 Docusaurus 开发的 Storybook 插件。
特性
- 添加了对 Docusaurus 模块别名的支持,例如
@theme
、@docusaurus
、@generated
和@site
。核心主题、插件提供的组件和 swizzled 组件的主题别名加载顺序也得到了遵守。了解主题别名 - 启用核心 Docusaurus 加载器,支持 JS、SVG、字体及其他资源。将优先使用 docusaurus-plugin-sass 而非 Storybook 的 SASS 加载器。
- 加载所有插件的客户端模块和Webpack 配置。
- 应用一个全局装饰器,将所有组件包裹在 Docusaurus React 上下文中,从而可以渲染所有 swizzled 组件。
安装与使用
此插件假定你正在使用一个已配置好 Docusaurus 和 Storybook 的项目。
安装插件
使用 npm
npm i storybook-addon-docusaurus
或使用 yarn
yarn add storybook-addon-docusaurus
启用插件
将 "storybook-addon-docusaurus"
添加到 Storybook 的 .storybook/main.js
文件中的 addons
列表中。了解更多。
大功告成!你现在应该能够编写使用 Docusaurus 组件的 stories 了。
许可
MIT