From efe9e3f12f56d2e152a4435678c3106074725e64 Mon Sep 17 00:00:00 2001 From: Cahllagerfeld <43843195+Cahllagerfeld@users.noreply.github.com> Date: Fri, 18 Aug 2023 10:20:32 +0000 Subject: [PATCH] feat: adjust storybook structure --- src/docs/Introduction.mdx | 14 ++++++++++++++ src/docs/Tailwind.mdx | 3 +++ src/docs/Utilitiets.mdx | 13 +++++++++++++ src/stories/{Configure.mdx => Configure.md} | 19 +++++++++++-------- 4 files changed, 41 insertions(+), 8 deletions(-) create mode 100644 src/docs/Introduction.mdx create mode 100644 src/docs/Tailwind.mdx create mode 100644 src/docs/Utilitiets.mdx rename src/stories/{Configure.mdx => Configure.md} (97%) diff --git a/src/docs/Introduction.mdx b/src/docs/Introduction.mdx new file mode 100644 index 0000000..2873aa2 --- /dev/null +++ b/src/docs/Introduction.mdx @@ -0,0 +1,14 @@ +import { Meta } from "@storybook/blocks"; + + + +
+ ZenML Logo +

ZenML Component Library

+
diff --git a/src/docs/Tailwind.mdx b/src/docs/Tailwind.mdx new file mode 100644 index 0000000..581397e --- /dev/null +++ b/src/docs/Tailwind.mdx @@ -0,0 +1,3 @@ +import { Meta } from "@storybook/blocks"; + + diff --git a/src/docs/Utilitiets.mdx b/src/docs/Utilitiets.mdx new file mode 100644 index 0000000..4ea7974 --- /dev/null +++ b/src/docs/Utilitiets.mdx @@ -0,0 +1,13 @@ +import { Meta } from "@storybook/blocks"; + + + +# Utilities + +The component library exposes a set of helpful utlitiy functions, that can be imported from `@zenml-io/react-component-library/utilities`. +The exposed utilities are decorated with JSDoc to improve the DX, and to make it as easy as possible to get +started with them. + +## Functions + +`cn` : Utility function for merging multiple Tailwind classes, allowing the usage of the clsx-syntax. The abbreviation stands for `classNames` diff --git a/src/stories/Configure.mdx b/src/stories/Configure.md similarity index 97% rename from src/stories/Configure.mdx rename to src/stories/Configure.md index a50fcea..3df550b 100644 --- a/src/stories/Configure.mdx +++ b/src/stories/Configure.md @@ -15,11 +15,11 @@ import Accessibility from "./assets/accessibility.png"; import Theming from "./assets/theming.png"; import AddonLibrary from "./assets/addon-library.png"; -export const RightArrow = () => - - + +> +> @@ -38,6 +38,7 @@ export const RightArrow = () =>
@@ -84,6 +85,7 @@ export const RightArrow = () =>
@@ -203,6 +205,7 @@ export const RightArrow = () => Discover tutorials
+