From 754e61a7f4456247eeef6878d1884e0e132f8e50 Mon Sep 17 00:00:00 2001 From: Davide Bizzi Date: Wed, 30 Oct 2024 09:37:28 +0100 Subject: [PATCH] docs: Add autodocs --- .storybook/main.js | 2 ++ .storybook/preview.tsx | 2 ++ package.json | 8 +++-- yarn.lock | 74 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 83 insertions(+), 3 deletions(-) diff --git a/.storybook/main.js b/.storybook/main.js index 206b18d6..e2f6fa0d 100644 --- a/.storybook/main.js +++ b/.storybook/main.js @@ -6,6 +6,8 @@ const config = { "@storybook/addon-essentials", "@storybook/addon-interactions", "@storybook/addon-a11y", + "@storybook/addon-docs", + "@storybook/addon-storysource", ], framework: { name: "@storybook/react-vite", diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx index 3e225a73..68f31170 100644 --- a/.storybook/preview.tsx +++ b/.storybook/preview.tsx @@ -37,3 +37,5 @@ export const parameters = { }, }, }; + +export const tags = ["autodocs"]; diff --git a/package.json b/package.json index 996c0ced..9b59d53a 100644 --- a/package.json +++ b/package.json @@ -54,6 +54,7 @@ "@tiptap/react": "2.2.4", "@tiptap/starter-kit": "2.2.4", "@tiptap/suggestion": "2.2.4", + "@types/react-slick": "^0.23.10", "@zendeskgarden/container-utilities": "^2.0.0", "@zendeskgarden/css-bedrock": "^9.0.0", "@zendeskgarden/react-accordions": "8.76.8", @@ -73,12 +74,11 @@ "@zendeskgarden/react-pagination": "8.76.8", "@zendeskgarden/react-tables": "8.76.8", "@zendeskgarden/react-tabs": "8.76.8", - "@zendeskgarden/react-theming": "8.76.8", "@zendeskgarden/react-tags": "8.76.8", + "@zendeskgarden/react-theming": "8.76.8", "@zendeskgarden/react-tooltips": "8.76.8", "@zendeskgarden/react-typography": "8.76.8", "react-slick": "^0.29.0", - "@types/react-slick": "^0.23.10", "tippy.js": "^6.3.7", "ua-parser-js": "^1.0.2", "uuid": "^9.0.1" @@ -89,9 +89,11 @@ "@babel/preset-typescript": "^7.21.5", "@rollup/plugin-image": "^3.0.2", "@storybook/addon-a11y": "^8.3.5", + "@storybook/addon-docs": "^8.3.6", "@storybook/addon-essentials": "^8.3.5", "@storybook/addon-interactions": "^8.3.5", "@storybook/addon-links": "^8.3.5", + "@storybook/addon-storysource": "^8.3.6", "@storybook/blocks": "^8.3.5", "@storybook/builder-vite": "^8.3.5", "@storybook/preset-create-react-app": "^8.3.5", @@ -105,7 +107,6 @@ "@types/node": "^20.14.2", "@types/react": "^17.0.0 || ^18.0.0", "@types/react-dom": "^17.0.0 || ^18.0.0", - "react-window": "^1.8.6", "@types/react-window": "^1.8.5", "@types/ua-parser-js": "^0.7.36", "@types/uuid": "^9.0.8", @@ -121,6 +122,7 @@ "prop-types": "^15.8.1", "react": "^18.2.0", "react-dom": "^18.2.0", + "react-window": "^1.8.6", "rimraf": "3.0.2", "rollup": "~2.66", "rollup-plugin-peer-deps-external": "^2.2.4", diff --git a/yarn.lock b/yarn.lock index 28e0a7c7..4edccec0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2493,6 +2493,24 @@ rehype-slug "^6.0.0" ts-dedent "^2.0.0" +"@storybook/addon-docs@^8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/addon-docs/-/addon-docs-8.3.6.tgz#b03ad160475b7920ef03833bd2674ea62f872d23" + integrity sha512-31Rk1TOhDIzGM2wNCUIB1xKuWtArW0D2Puua9warEXlQ3FtvwmxnPrwbIzw6ufYZDWPwl9phDYTcRh8WqZIoGg== + dependencies: + "@mdx-js/react" "^3.0.0" + "@storybook/blocks" "8.3.6" + "@storybook/csf-plugin" "8.3.6" + "@storybook/global" "^5.0.0" + "@storybook/react-dom-shim" "8.3.6" + "@types/react" "^16.8.0 || ^17.0.0 || ^18.0.0" + fs-extra "^11.1.0" + react "^16.8.0 || ^17.0.0 || ^18.0.0" + react-dom "^16.8.0 || ^17.0.0 || ^18.0.0" + rehype-external-links "^3.0.0" + rehype-slug "^6.0.0" + ts-dedent "^2.0.0" + "@storybook/addon-essentials@^8.3.5": version "8.3.5" resolved "https://registry.npmjs.org/@storybook/addon-essentials/-/addon-essentials-8.3.5.tgz#59599a75e3f72d1048d715f3ec35a4c07149b2f8" @@ -2552,6 +2570,15 @@ "@storybook/global" "^5.0.0" ts-dedent "^2.0.0" +"@storybook/addon-storysource@^8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/addon-storysource/-/addon-storysource-8.3.6.tgz#c3d443bf9f0507e58338da4bc09fcce35439d53a" + integrity sha512-L35BJj8vO+jIHSVjCCygoQCHSPt6wiviOLkOMgY1KluslXGHfwHd5am5y9sy4YuFl21SyFPw525/yZj9SLgqpA== + dependencies: + "@storybook/source-loader" "8.3.6" + estraverse "^5.2.0" + tiny-invariant "^1.3.1" + "@storybook/addon-toolbars@8.3.5": version "8.3.5" resolved "https://registry.npmjs.org/@storybook/addon-toolbars/-/addon-toolbars-8.3.5.tgz#7328fed0f4a24c6828ba23e06b9cddd0d3e00e2b" @@ -2584,6 +2611,26 @@ ts-dedent "^2.0.0" util-deprecate "^1.0.2" +"@storybook/blocks@8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/blocks/-/blocks-8.3.6.tgz#ac2e4f07a4df23004b3361c592c2cffe6b95464a" + integrity sha512-Oc5jU6EzfsENjrd91KcKyEKBh60RT+8uyLi1RIrymC2C/mzZMTEoNIrbnQt0eIqbjlHxn6y9JMJxHu4NJ4EmZg== + dependencies: + "@storybook/csf" "^0.1.11" + "@storybook/global" "^5.0.0" + "@storybook/icons" "^1.2.10" + "@types/lodash" "^4.14.167" + color-convert "^2.0.1" + dequal "^2.0.2" + lodash "^4.17.21" + markdown-to-jsx "^7.4.5" + memoizerific "^1.11.3" + polished "^4.2.2" + react-colorful "^5.1.2" + telejson "^7.2.0" + ts-dedent "^2.0.0" + util-deprecate "^1.0.2" + "@storybook/builder-vite@8.3.5", "@storybook/builder-vite@^8.3.5": version "8.3.5" resolved "https://registry.npmjs.org/@storybook/builder-vite/-/builder-vite-8.3.5.tgz#2586b3154b9cd1877d6265a724d59287bdda8b5f" @@ -2671,6 +2718,13 @@ dependencies: unplugin "^1.3.1" +"@storybook/csf-plugin@8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/csf-plugin/-/csf-plugin-8.3.6.tgz#8e6fd04f1dd4662f85f6c1e8fa56d4331f3be4c7" + integrity sha512-TJyJPFejO6Gyr3+bXqE/+LomQbivvfHEbee/GwtlRj0XF4KQlqnvuEdEdcK25JbD0NXT8AbyncEUmjoxE7ojQw== + dependencies: + unplugin "^1.3.1" + "@storybook/csf@^0.1.11": version "0.1.11" resolved "https://registry.npmjs.org/@storybook/csf/-/csf-0.1.11.tgz#ad685a4fe564a47a6b73571c2e7c07b526f4f71b" @@ -2755,6 +2809,11 @@ resolved "https://registry.npmjs.org/@storybook/react-dom-shim/-/react-dom-shim-8.3.5.tgz#dda5356d3bf55623b9b1429fac7bf185e59c58fd" integrity sha512-Hf0UitJ/K0C7ajooooUK/PxOR4ihUWqsC7iCV1Gqth8U37dTeLMbaEO4PBwu0VQ+Ufg0N8BJLWfg7o6G4hrODw== +"@storybook/react-dom-shim@8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/react-dom-shim/-/react-dom-shim-8.3.6.tgz#40ce82a4e6559a617c4a7288b532652fefcd271e" + integrity sha512-9BO6VXIdli4GHSfiP/Z0gwAf7oQig3D/yWK2U1+91UWDV8nIAgnNBAi76U4ORC6MiK5MdkDfIikIxnLLeLnahA== + "@storybook/react-vite@^8.3.5": version "8.3.5" resolved "https://registry.npmjs.org/@storybook/react-vite/-/react-vite-8.3.5.tgz#c1aeb06b5962abb77a7d0d0ba08269bff35756f1" @@ -2806,6 +2865,16 @@ type-fest "~2.19" util-deprecate "^1.0.2" +"@storybook/source-loader@8.3.6": + version "8.3.6" + resolved "https://registry.npmjs.org/@storybook/source-loader/-/source-loader-8.3.6.tgz#1a14c1d4b1ab099770cbb755cf0149dc656800fd" + integrity sha512-czgQVFMsqeXe0pXjbore8X91gUOnpVVIv2dWsgS2UN9sHh+4B/Uevxx6Lz21074aynGO4bNti1BETGelejIM6w== + dependencies: + "@storybook/csf" "^0.1.11" + estraverse "^5.2.0" + lodash "^4.17.21" + prettier "^3.1.1" + "@storybook/test@8.3.5": version "8.3.5" resolved "https://registry.npmjs.org/@storybook/test/-/test-8.3.5.tgz#0dffc9d4a1eaa9552e69457b16b5085e36883c8a" @@ -8139,6 +8208,11 @@ prelude-ls@^1.2.1: resolved "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== +prettier@^3.1.1: + version "3.3.3" + resolved "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105" + integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew== + pretty-error@^4.0.0: version "4.0.0" resolved "https://registry.npmjs.org/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6"