Skip to content

Commit 0e3d82e

Browse files
feat: adjust storybook structure (#5)
1 parent f22e088 commit 0e3d82e

File tree

4 files changed

+41
-8
lines changed

4 files changed

+41
-8
lines changed

src/docs/Introduction.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { Meta } from "@storybook/blocks";
2+
3+
<Meta title="Introduction" />
4+
5+
<div align="center">
6+
<img
7+
style={{ marginBottom: "16px" }}
8+
alt="ZenML Logo"
9+
src="https://user-images.githubusercontent.com/3348134/223112746-345126ff-a0e8-479f-8ac0-670d78f71712.png"
10+
alt="Logo"
11+
width="400"
12+
/>
13+
<h1>ZenML Component Library</h1>
14+
</div>

src/docs/Tailwind.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { Meta } from "@storybook/blocks";
2+
3+
<Meta title="Docs/Tailwind" />

src/docs/Utilitiets.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import { Meta } from "@storybook/blocks";
2+
3+
<Meta title="Docs/Utilities" />
4+
5+
# Utilities
6+
7+
The component library exposes a set of helpful utlitiy functions, that can be imported from `@zenml-io/react-component-library/utilities`.
8+
The exposed utilities are decorated with JSDoc to improve the DX, and to make it as easy as possible to get
9+
started with them.
10+
11+
## Functions
12+
13+
`cn` : Utility function for merging multiple Tailwind classes, allowing the usage of the clsx-syntax. The abbreviation stands for `classNames`

src/stories/Configure.mdx renamed to src/stories/Configure.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ import Accessibility from "./assets/accessibility.png";
1515
import Theming from "./assets/theming.png";
1616
import AddonLibrary from "./assets/addon-library.png";
1717

18-
export const RightArrow = () => <svg
19-
viewBox="0 0 14 14"
20-
width="8px"
21-
height="14px"
22-
style={{
18+
export const RightArrow = () => <svg
19+
viewBox="0 0 14 14"
20+
width="8px"
21+
height="14px"
22+
style={{
2323
marginLeft: '4px',
2424
display: 'inline-block',
2525
shapeRendering: 'inherit',
2626
verticalAlign: 'middle',
2727
fill: 'currentColor',
2828
'path fill': 'currentColor'
2929
}}
30-
>
31-
<path d="m11.1 7.35-5.5 5.5a.5.5 0 0 1-.7-.7L10.04 7 4.9 1.85a.5.5 0 1 1 .7-.7l5.5 5.5c.2.2.2.5 0 .7Z" />
32-
</svg>
30+
31+
> <path d="m11.1 7.35-5.5 5.5a.5.5 0 0 1-.7-.7L10.04 7 4.9 1.85a.5.5 0 1 1 .7-.7l5.5 5.5c.2.2.2.5 0 .7Z" />
32+
> </svg>
3333
3434
<Meta title="Configure your project" />
3535

@@ -38,6 +38,7 @@ export const RightArrow = () => <svg
3838
# Configure your project
3939

4040
Because Storybook works separately from your app, you'll need to configure it for your specific stack and setup. Below, explore guides for configuring Storybook with popular frameworks and tools. If you get stuck, learn how you can ask for help from our community.
41+
4142
</div>
4243
<div className="sb-section">
4344
<div className="sb-section-item">
@@ -84,6 +85,7 @@ export const RightArrow = () => <svg
8485
# Do more with Storybook
8586

8687
Now that you know the basics, let's explore other parts of Storybook that will improve your experience. This list is just to get you started. You can customise Storybook in many ways to fit your needs.
88+
8789
</div>
8890

8991
<div className="sb-section">
@@ -203,6 +205,7 @@ export const RightArrow = () => <svg
203205
target="_blank"
204206
>Discover tutorials<RightArrow /></a>
205207
</div>
208+
206209
</div>
207210

208211
<style>

0 commit comments

Comments
 (0)