diff --git a/packages/docs/ReleaesNote.scripts.md b/packages/docs/ReleaesNote.scripts.md index 27c9f58ed70432d6327b638d503f7fde511b81d6..84f0a91513fc8512e4ee1dbd48a46930d4169c8d 100644 --- a/packages/docs/ReleaesNote.scripts.md +++ b/packages/docs/ReleaesNote.scripts.md @@ -1,5 +1,11 @@ # [open-scripts] +# 1.0.0 + +- fix + +1. 统一gen-icon在不同系统下生成path的分隔符风格 + # 0.0.23 - fix diff --git a/packages/docs/public/opendesign-logo-dark.png b/packages/docs/public/opendesign-logo-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..9b90c7b1bfc792b20397106b0c720e1ae507c540 Binary files /dev/null and b/packages/docs/public/opendesign-logo-dark.png differ diff --git a/packages/docs/public/opendesign-logo-light.png b/packages/docs/public/opendesign-logo-light.png new file mode 100644 index 0000000000000000000000000000000000000000..24633e626b911f5d9c172674a5783d18ecb9a2ec Binary files /dev/null and b/packages/docs/public/opendesign-logo-light.png differ diff --git a/packages/opendesign/README.md b/packages/opendesign/README.md index b6adf0304ef99a3e0539fa367c8cac32584a6a92..cac4111197e5c3d14b6ac7b56514368d27e8090b 100644 --- a/packages/opendesign/README.md +++ b/packages/opendesign/README.md @@ -1,3 +1,56 @@ -# opendesign components +
一个 Vue 3 组件库
+皮肤可定制,使用 TypeScript
-- vue3 components for opendesign + +## 特性 + + +### 皮肤可定制 + +提供组件变量体系,可以快速定义一套新皮肤 + +### 使用 TypeScript + +opendesign 全量使用 TypeScript 编写,和你的 TypeScript 项目无缝衔接。 + + +## 安装 + +### npm + +使用 npm/pnpm 安装。 + +```bash +# npm +npm i @opensig/opendesign + +#pnpm +pnpm add @opensig/opendesign + +``` + + +## 使用 + +### 引入样式文件 +``` +import '@opensig/opendesign/es/index.scss' +``` + +### 使用组件 +``` + + +用于构件opendesign组件库、图标库
-# 1.0.0 +## 特性 -- 【fix】统一gen-icon在不同系统下生成path的分隔符风格 -# 0.0.20 +### 组件构建 -- 【fix】修复图标路径兼容性、文件名转变量名兼容性、不同实例同 id 的相互影响 +支持构建vue组件库,编译样式文件 + +### 图标构建 + +支持将svg文件构建为vue组件 + + +### token构建 + +支持基于配置文件生成token文件 + + +## 安装 + +### npm + +使用 npm/pnpm 安装。 + +```bash +# npm +npm i @opensig/open-scripts + +#pnpm +pnpm add @opensig/open-scripts + +``` + + +## 许可 + +opendesign 使用 [MIT license](https://opensource.org/licenses/MIT) 许可证书。 \ No newline at end of file