diff --git a/README.md b/README.md index 0ae53c4..745bb65 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,48 @@ # mds **The Design System for SOPT makers** +> makers design system(mds) is a design system created to support the goals of approximately 50 members across 5 teams -- Links - - [Github](https://github.com/sopt-makers/makers-design-system) - - [npm](https://www.npmjs.com/search?q=%40sopt-makers) - - [Storybook](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/configure-your-project--docs) -- Packages - - [@sopt-makers/colors](https://www.npmjs.com/package/@sopt-makers/colors) - - [@sopt-makers/icon](https://www.npmjs.com/package/@sopt-makers/icons) - - [@sopt-makers/fonts](https://www.npmjs.com/package/@sopt-makers/fonts) - - [@sopt-makers/ui](https://www.npmjs.com/package/@sopt-makers/ui) -- Maintainers(SOPT 35th) +
+ +## Links + +[Github](https://github.com/sopt-makers/makers-design-system) / [npm](https://www.npmjs.com/search?q=%40sopt-makers) / [Storybook](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/introduction--docs) + +## Packages(npm) + +- [@sopt-makers/colors](https://www.npmjs.com/package/@sopt-makers/colors) +- [@sopt-makers/icon](https://www.npmjs.com/package/@sopt-makers/icons) +- [@sopt-makers/fonts](https://www.npmjs.com/package/@sopt-makers/fonts) +- [@sopt-makers/ui](https://www.npmjs.com/package/@sopt-makers/ui) + +## Components(ui) + +- [Button](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-button--docs) +- [Callout](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-button--docs) +- Control + - [Checkbox](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-checkbox--docs) + - [Radio](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-radio--docs) + - [Toggle](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-toggle--docs) +- [Chip](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-chip--docs) +- [Dialog](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-dialog--docs) +- [FieldBox](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-fieldbox--docs) +- Input + - [SearchField](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-searchfield--docs) + - [Select(V2)](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-selectv2-withtriggercontent--docs) + - [TextArea](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-textarea--docs) + - [TextField](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-textfield--docs) + - [UserMention](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-usermention--docs) +- [Skeleton](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-skeleton--docs) +- [Tab](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-tab--docs) +- [Tag](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-tag--docs) +- [Toast](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-toast--docs) + +## Design Tokens and Icons + +### [Colors](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/colors-colors--default) / [Fonts](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/fonts-fonts--default) / [Icons](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/icons-icons--default) + +## Maintainers(SOPT 35th) - [Sohee Kwon](https://github.com/sohee-K) - [Hyeongkyeom Kim](https://github.com/Brokyeom) - [Jungwoo Lee](https://github.com/jungwoo3490) diff --git a/apps/docs/CHANGELOG.md b/apps/docs/CHANGELOG.md index ed44327..2347d98 100644 --- a/apps/docs/CHANGELOG.md +++ b/apps/docs/CHANGELOG.md @@ -1,5 +1,11 @@ # docs +## 0.0.10 + +### Patch Changes + +- 20e8b05: write Introduction + ## 0.0.9 ### Patch Changes diff --git a/apps/docs/package.json b/apps/docs/package.json index b25c955..d9b252c 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -1,7 +1,7 @@ { "name": "docs", "private": true, - "version": "0.0.9", + "version": "0.0.10", "type": "module", "scripts": { "dev": "vite", diff --git a/apps/docs/src/stories/Configure.mdx b/apps/docs/src/stories/Configure.mdx index 2cfa156..f8a4482 100644 --- a/apps/docs/src/stories/Configure.mdx +++ b/apps/docs/src/stories/Configure.mdx @@ -1,8 +1,51 @@ -import { Meta } from "@storybook/blocks"; +import { Meta } from '@storybook/blocks'; - + -

SOPT MAKERS Design System

+# makers design system (mds) - +### The Design System for SOPT makers + +> makers design system(mds) is a design system created to support the goals of approximately 50 members across 5 teams + +
+
+ +## Links + +[Github](https://github.com/sopt-makers/makers-design-system) / [npm](https://www.npmjs.com/search?q=%40sopt-makers) + +## Packages(npm) + +- [@sopt-makers/colors](https://www.npmjs.com/package/@sopt-makers/colors) +- [@sopt-makers/icon](https://www.npmjs.com/package/@sopt-makers/icons) +- [@sopt-makers/fonts](https://www.npmjs.com/package/@sopt-makers/fonts) +- [@sopt-makers/ui](https://www.npmjs.com/package/@sopt-makers/ui) + +## Components(ui) + +- [Button](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-button--docs) +- [Callout](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-button--docs) +- Control + - [Checkbox](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-checkbox--docs) + - [Radio](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-radio--docs) + - [Toggle](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-control-toggle--docs) +- [Chip](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-chip--docs) +- [Dialog](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-dialog--docs) +- [FieldBox](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-fieldbox--docs) +- Input + - [SearchField](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-searchfield--docs) + - [Select(V2)](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-selectv2-withtriggercontent--docs) + - [TextArea](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-textarea--docs) + - [TextField](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-textfield--docs) + - [UserMention](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-input-usermention--docs) +- [Skeleton](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-skeleton--docs) +- [Tab](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-tab--docs) +- [Tag](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-tag--docs) +- [Toast](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/docs/components-toast--docs) + +## Design Tokens and Icons + +### [Colors](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/colors-colors--default) / [Fonts](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/fonts-fonts--default) / [Icons](https://main--6571c88390d085ed7efcce84.chromatic.com/?path=/story/icons-icons--default) + +