Skip to content

Commit 03996e8

Browse files
committed
chore: fix documentation in storybook
1 parent e5be037 commit 03996e8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+191
-77
lines changed

.storybook/main.js

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// @ts-check
2+
import remarkGfm from 'remark-gfm';
23

34
/** @type {import('@storybook/core-common').StorybookConfig} */
45
const config = {
@@ -18,7 +19,7 @@ const config = {
1819
modernInlineRender: true,
1920
},
2021

21-
stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
22+
stories: ['../src/**/*.docs.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
2223

2324
addons: [
2425
'@storybook/addon-links',
@@ -32,6 +33,16 @@ const config = {
3233
},
3334
},
3435
},
36+
{
37+
name: '@storybook/addon-docs',
38+
options: {
39+
mdxPluginOptions: {
40+
mdxCompileOptions: {
41+
remarkPlugins: [remarkGfm],
42+
},
43+
},
44+
},
45+
},
3546
],
3647

3748
docs: {

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
"react-stately": "^3.35.0",
8080
"react-transition-group": "^4.4.5",
8181
"react-types": "^0.1.0",
82+
"remark-gfm": "^4.0.1",
8283
"tiny-invariant": "^1.3.3",
8384
"usehooks-ts": "^3.1.0",
8485
"valid-url": "^1.0.9"

pnpm-lock.yaml

Lines changed: 11 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/components/content/ActiveZone/ActiveZone.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,7 @@ function ActiveZone(
7373
}
7474

7575
const _ActiveZone = forwardRef(ActiveZone);
76+
77+
_ActiveZone.displayName = 'ActiveZone';
78+
7679
export { _ActiveZone as ActiveZone };

src/components/content/CopyPasteBlock/CopyPasteBlock.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,4 +233,6 @@ function CopyPasteBlock(
233233

234234
const _CopyPasteBlock = forwardRef(CopyPasteBlock);
235235

236+
_CopyPasteBlock.displayName = 'CopyPasteBlock';
237+
236238
export { _CopyPasteBlock as CopyPasteBlock };

src/components/content/CopySnippet/CopySnippet.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,4 +265,6 @@ const _CopySnippet = Object.assign(
265265
},
266266
);
267267

268+
_CopySnippet.displayName = 'CopySnippet';
269+
268270
export { _CopySnippet as CopySnippet };

src/components/content/Header.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ const HeaderElement = tasty({
2121
display: 'block',
2222
gridArea: 'header',
2323
flow: 'column',
24+
boxSizing: 'border-box',
2425
},
2526
});
2627

src/components/content/PrismCode/PrismCode.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,7 @@ function PrismCode(props: CubePrismCodeProps, ref) {
102102
* Code block with syntax highlighting
103103
*/
104104
const _PrismCode = forwardRef(PrismCode);
105+
106+
_PrismCode.displayName = 'PrismCode';
107+
105108
export { _PrismCode as PrismCode };

src/components/content/Result/Result.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,6 @@ function Result(props: CubeResultProps, ref) {
223223

224224
const _Result = forwardRef(Result);
225225

226+
_Result.displayName = 'Result';
227+
226228
export { _Result as Result };

src/components/content/Tag/Tag.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,7 @@ function Tag(allProps: CubeTagProps, ref) {
131131
}
132132

133133
const _Tag = forwardRef(Tag);
134+
135+
_Tag.displayName = 'Tag';
136+
134137
export { _Tag as Tag };

0 commit comments

Comments
 (0)