diff --git a/.storybook/main.ts b/.storybook/main.ts index 9de6030e58..1eea577b5c 100644 --- a/.storybook/main.ts +++ b/.storybook/main.ts @@ -2,7 +2,7 @@ import type { StorybookConfig } from '@storybook/web-components-vite'; import { type BuildOptions, type UserConfig, mergeConfig } from 'vite'; const config: StorybookConfig = { - stories: ['../docs/**/*.mdx', '../src/**/*.stories.ts'], + stories: ['../src/**/*.mdx', '../src/**/*.stories.ts'], addons: ['@storybook/addon-essentials', '@storybook/addon-a11y', '@storybook/addon-interactions'], framework: { name: '@storybook/web-components-vite', diff --git a/README.md b/README.md index c6d959043c..507cea4f10 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ## 🎯 Our aim -To fulfill our [Vision](./docs/VISION.mdx), we are building and maintaining Lyne, our Design System, which is and acts +To fulfill our [Vision](./docs/VISION.md), we are building and maintaining Lyne, our Design System, which is and acts as our common language — our Single Source of Truth. For this purpose we use [Design Tokens](https://github.com/lyne-design-system/lyne-design-tokens) as our design abstractions. Those [Design Tokens](https://github.com/lyne-design-system/lyne-design-tokens) are consumed by Lyne Components and are integrated within our documentation. @@ -18,7 +18,7 @@ Lyne Design Tokens and Lyne Components are available for developers and designer - General docs: [digital.sbb.ch](https://digital.sbb.ch) - Component docs: [Storybook](https://lyne-storybook.app.sbb.ch) -- [Getting started guide](./docs/GETTING_STARTED.mdx) +- [Getting started guide](./docs/GETTING_STARTED.md) ## 🔗 Packages diff --git a/docs/GETTING_STARTED.mdx b/docs/GETTING_STARTED.md similarity index 98% rename from docs/GETTING_STARTED.mdx rename to docs/GETTING_STARTED.md index 6a99ead5c4..82eaff0a9a 100644 --- a/docs/GETTING_STARTED.mdx +++ b/docs/GETTING_STARTED.md @@ -1,7 +1,3 @@ -import { Meta } from '@storybook/blocks'; - - - # Getting Started Basic steps to integrate the lyne components into your project. diff --git a/docs/VISION.mdx b/docs/VISION.md similarity index 97% rename from docs/VISION.mdx rename to docs/VISION.md index e84bab77dc..f7b9d26582 100644 --- a/docs/VISION.mdx +++ b/docs/VISION.md @@ -1,7 +1,3 @@ -import { Meta } from '@storybook/blocks'; - - - # Lyne Design System — Vision ## What _Lyne_ is and why we need it diff --git a/src/storybook/docs/getting-started.mdx b/src/storybook/docs/getting-started.mdx new file mode 100644 index 0000000000..86193db024 --- /dev/null +++ b/src/storybook/docs/getting-started.mdx @@ -0,0 +1,7 @@ +import { Markdown, Meta } from '@storybook/blocks'; + +import GettingStarted from '../../../docs/GETTING_STARTED.md?raw'; + + + +{GettingStarted} diff --git a/src/storybook/docs/vision.mdx b/src/storybook/docs/vision.mdx new file mode 100644 index 0000000000..bde5bf70dc --- /dev/null +++ b/src/storybook/docs/vision.mdx @@ -0,0 +1,7 @@ +import { Markdown, Meta } from '@storybook/blocks'; + +import Vision from '../../../docs/VISION.md?raw'; + + + +{Vision}