docs(root ui/docs): 新增todo list

affects: @varlet/cli, @varlet/ui
varletjs · Apr 24, 2021 · ed8f3aa · ed8f3aa
1 parent 7a846e9
commit ed8f3aa
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 7 deletions.
diff --git a/TODO-zh-CN.md b/TODO-zh-CN.md
@@ -0,0 +1,11 @@
+# 下一步开发计划
+
+### 介绍
+
+这里为您介绍组件库下一步开发计划，欢迎社区小伙伴参与其中。
+
+### Todo list
+- 1.提供jsx，tsx语法高亮支持。
+- 2.完善文档阅读体验，修复存在的问题。
+- 3.全组件单元测试，并出测试报告。
+- 4.全组件样式细节优化，动画曲线优化。
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,11 @@
+# Todo
+
+### Intro
+
+Here we introduce the next development plan of the component library, welcome the community partners to participate in it.
+
+### Todo list
+- 1.Provides `jsx`, `tsx` syntax highlighting support
+- 2.Improve the document reading experience and fix problems.
+- 3.Unit test all components and issue test report.
+- 4.Full component style detail optimization, animation curve optimization.
diff --git a/packages/varlet-cli/site/site.config.json b/packages/varlet-cli/site/site.config.json
@@ -87,6 +87,14 @@
         "doc": "highlight",
         "nonComponent": true
       },
+      {
+        "text": {
+          "zh-CN": "Todo",
+          "en-US": "Todo"
+        },
+        "doc": "todo",
+        "nonComponent": true
+      },
       {
         "text": {
           "zh-CN": "基础组件",

diff --git a/packages/varlet-ui/docs/todo.en-US.md b/packages/varlet-ui/docs/todo.en-US.md
@@ -0,0 +1,11 @@
+# Todo
+
+### Intro
+
+Here we introduce the next development plan of the component library, welcome the community partners to participate in it.
+
+### Todo list
+- 1.Provides `jsx`, `tsx` syntax highlighting support
+- 2.Improve the document reading experience and fix problems.
+- 3.Unit test all components and issue test report.
+- 4.Full component style detail optimization, animation curve optimization.
diff --git a/packages/varlet-ui/docs/todo.zh-CN.md b/packages/varlet-ui/docs/todo.zh-CN.md
@@ -0,0 +1,11 @@
+# 下一步开发计划
+
+### 介绍
+
+这里为您介绍组件库下一步开发计划，欢迎社区小伙伴参与其中。
+
+### Todo list
+- 1.提供`jsx`，`tsx`语法高亮支持。
+- 2.完善文档阅读体验，修复存在的问题。
+- 3.全组件单元测试，并出测试报告。
+- 4.全组件样式细节优化，动画曲线优化。
diff --git a/packages/varlet-ui/types/button.d.ts b/packages/varlet-ui/types/button.d.ts
@@ -1,3 +1,3 @@
-import { VarComponent } from './varComponent';
+import { VarComponent } from './varComponent'
 
 export class Button extends VarComponent {}
diff --git a/packages/varlet-ui/varlet.config.js b/packages/varlet-ui/varlet.config.js
@@ -84,6 +84,14 @@ module.exports = {
         doc: 'highlight',
         nonComponent: true,
       },
+      {
+        text: {
+          'zh-CN': 'Todo',
+          'en-US': 'Todo',
+        },
+        doc: 'todo',
+        nonComponent: true,
+      },
       {
         text: {
           'zh-CN': '基础组件',

diff --git a/yarn.lock b/yarn.lock
@@ -3884,14 +3884,14 @@ camelcase@^6.0.0, camelcase@^6.1.0:
   integrity sha512-c7wVvbw3f37nuobQNtgsgG9POC9qMbNuMQmTCqZv23b6MIz0fcYpBiOlv9gEN/hdLdnZTDQhg6e9Dq5M1vKvfg==
 
 caniuse-lite@^1.0.30001109, caniuse-lite@^1.0.30001154:
-  version "1.0.30001154"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001154.tgz#f3bbc245ce55e4c1cd20fa731b097880181a7f17"
-  integrity sha512-y9DvdSti8NnYB9Be92ddMZQrcOe04kcQtcxtBx4NkB04+qZ+JUWotnXBJTmxlKudhxNTQ3RRknMwNU2YQl/Org==
+  version "1.0.30001214"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001214.tgz"
+  integrity sha512-O2/SCpuaU3eASWVaesQirZv1MSjUNOvmugaD8zNSJqw6Vv5SGwoOpA9LJs3pNPfM745nxqPvfZY3MQKY4AKHYg==
 
 caniuse-lite@^1.0.30001181:
-  version "1.0.30001187"
-  resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001187.tgz#5706942631f83baa5a0218b7dfa6ced29f845438"
-  integrity sha512-w7/EP1JRZ9552CyrThUnay2RkZ1DXxKe/Q2swTC4+LElLh9RRYrL1Z+27LlakB8kzY0fSmHw9mc7XYDUKAKWMA==
+  version "1.0.30001214"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001214.tgz"
+  integrity sha512-O2/SCpuaU3eASWVaesQirZv1MSjUNOvmugaD8zNSJqw6Vv5SGwoOpA9LJs3pNPfM745nxqPvfZY3MQKY4AKHYg==
 
 capture-exit@^2.0.0:
   version "2.0.0"