fix: edit readme

kktjs · Mar 25, 2023 · 5327f50 · 5327f50
1 parent f7f74b2
commit 5327f50
Show file tree

Hide file tree

Showing 14 changed files with 109 additions and 23 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -171,3 +171,10 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./website/build
+
+      - name: Generate Contributors Images
+        uses: jaywcjlove/github-action-contributors@main
+        with:
+          filter-author: (renovate\[bot\]|actions-user|renovate-bot|dependabot\[bot\])
+          output: ./website/build/CONTRIBUTORS.svg
+          avatarSize: 42
diff --git a/core/README.md b/core/README.md
@@ -31,6 +31,12 @@ $ npm install @kkt/pro -D # yarn add @kkt/pro -D
 - 权限管理[@kkt/plugin-pro-access](https://github.com/kktjs/kkt-pro/tree/main/packages/plugin/access)
 - 包集成管理[@kkt/pro](https://github.com/kktjs/kkt-pro/tree/main/packages/plugin/pro)
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/create-kktp/README.md b/packages/create-kktp/README.md
@@ -90,7 +90,12 @@ Example:
 
 Copyright 2023
 ```
+### Contributors
 
-## License
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/access/README.md b/packages/plugin/access/README.md
@@ -70,6 +70,12 @@ export default {
 }
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/config/README.md b/packages/plugin/config/README.md
@@ -139,6 +139,12 @@ export default {
 }
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/entry/README.md b/packages/plugin/entry/README.md
@@ -28,3 +28,13 @@ export default {
   initRoutes:true,
 }
 ```
+
+### Contributors
+
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/pro/README.md b/packages/plugin/pro/README.md
@@ -58,3 +58,13 @@ export interface KktproPageProps extends KktproIProps {
   routes: KktproRoutesProps[];
 }
 ```
+
+### Contributors
+
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/rematch/README.md b/packages/plugin/rematch/README.md
@@ -75,6 +75,12 @@ export default {
 }
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/packages/plugin/router/README.md b/packages/plugin/router/README.md
@@ -98,6 +98,12 @@ export default {
 }
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/website/package.json b/website/package.json
@@ -17,6 +17,9 @@
     "@rematch/core": "2.2.0",
     "@rematch/loading": "2.1.2",
     "@uiw-admin/exceptions": "~5.3.21",
+    "@uiw/react-markdown-preview": "^4.1.10",
+    "react-code-preview-layout": "^3.0.0",
+    "rehype-rewrite": "^3.0.6",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
     "react-redux": "^8.0.5",
@@ -37,10 +40,7 @@
     "@types/styled-components": "^5.1.26",
     "styled-components": "^5.3.9",
     "hast": "^1.0.0",
-    "@uiw/react-markdown-preview": "^4.1.10",
     "markdown-react-code-preview-loader": "^2.1.5",
-    "react-code-preview-layout": "^3.0.0",
-    "rehype-rewrite": "^3.0.6",
     "kktp": "^1.0.7"
   },
   "eslintConfig": {

diff --git a/website/src/pages/directory-structure/README.md b/website/src/pages/directory-structure/README.md
@@ -66,6 +66,12 @@
 └── src
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/website/src/pages/kktp/README.md b/website/src/pages/kktp/README.md
@@ -31,6 +31,12 @@ $ npm install @kkt/pro -D # yarn add @kkt/pro -D
 - 权限管理[@kkt/plugin-pro-access](https://github.com/kktjs/kkt-pro/tree/main/packages/plugin/access)
 - 包集成管理[@kkt/pro](https://github.com/kktjs/kkt-pro/tree/main/packages/plugin/pro)
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/website/src/pages/proxy/README.md b/website/src/pages/proxy/README.md
@@ -206,6 +206,12 @@ export default {
 }
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.
diff --git a/website/src/pages/update-kktp/README.md b/website/src/pages/update-kktp/README.md
@@ -70,6 +70,12 @@ import {
 } from '@kkt/pro';
 ```
 
-## License
+### Contributors
 
-[MIT © Kenny Wong](https://github.com/jaywcjlove)
+<a href="https://github.com/kktjs/kkt-pro/graphs/contributors">
+  <img src="https://kktjs.github.io/kkt-pro/CONTRIBUTORS.svg" />
+</a>
+
+### License
+
+Licensed under the MIT License.