docs: migration website to quark-ecosystem

hellof2e · Mar 28, 2024 · cd7dd50 · cd7dd50
1 parent a1fd820
commit cd7dd50
Show file tree

Hide file tree

Showing 15 changed files with 146 additions and 92 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature-report.zh-CN.yml b/.github/ISSUE_TEMPLATE/feature-report.zh-CN.yml
@@ -8,7 +8,7 @@
 #         # 欢迎你的参与 Quark Design 的新功能建议。
 
 #         在发布一个 Issue 前，请确保：
-#         - 在 [常见问题](https://quarkc.hellobike.com/#/zh-CN/guide/notice)、[更新日志](https://quarkc.hellobike.com/#/zh-CN/guide/changelog) 和 [旧Issue列表](https://github.com/hellof2e/quark-design/issues) 中搜索过你的问题。（你的问题可能已有人提出，也可能已在最新版本中被修正）
+#         - 在 [常见问题](https://quark-ecosystem.github.io/quarkc-docs/#/zh-CN/guide/notice)、[更新日志](https://quark-ecosystem.github.io/quarkc-docs/#/zh-CN/guide/changelog) 和 [旧Issue列表](https://github.com/hellof2e/quark-design/issues) 中搜索过你的问题。（你的问题可能已有人提出，也可能已在最新版本中被修正）
 #         - 如果你发现一个已经关闭的旧 Issue 在最新版本中仍然存在，不要在旧 Issue 下面留言，请建一个新的 issue。
 
 #   - type: textarea

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://quarkc.hellobike.com/">
+  <a href="https://quark-ecosystem.github.io/quarkd-docs">
     <img src="https://github.com/hellof2e/quark-design/assets/14307551/45ca3969-3f92-49a1-84fa-a4e6160cb7f4" />
   </a>
 </p>
@@ -36,7 +36,7 @@ Next-gen frontend component library, it can be used in any framework or no frame
 
 ## Documentation
 
-For full documentation, visit [https://quark-design.hellobike.com](https://quark-design.hellobike.com/).
+For full documentation, visit [https://quark-ecosystem.github.io/quarkd-docs](https://quark-ecosystem.github.io/quarkd-docs).
 
 ## Install
 
@@ -50,7 +50,9 @@ npm install quarkd
 import "quarkd/lib/button";
 
 // like a normal div tag `<div>xx</div>`, can be used in any browser.
-<quark-button type="primary" onclick="onClick">Button</quark-button>
+<quark-button type="primary" onclick="onClick">
+  Button
+</quark-button>;
 ```
 
 ```html
@@ -61,7 +63,7 @@ import "quarkd/lib/button";
 <quark-button type="primary" @click="onClick">Button</quark-button>
 
 // svelte
-<quark-button type="primary" on:click={onClick}>Button</quark-button>
+<quark-button type="primary" on:click="{onClick}">Button</quark-button>
 
 // angular
 <quark-button type="primary" (click)="onClick">Button</quark-button>
@@ -80,4 +82,3 @@ For help, discussion about best practices, or any other conversation that would
 ## Contributing
 
 If you're interested in contributing to quark design, please read our [contributing docs](https://github.com/hellof2e/quark-design/blob/main/CONTRIBUTING.md) **before submitting a pull request**.
-
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://quarkc.hellobike.com/">
+  <a href="https://quark-ecosystem.github.io/quarkc-docs">
     <img width="120" src="https://user-images.githubusercontent.com/14307551/197440754-08db4379-eb0f-4808-890d-690355e6e8d2.png">
   </a>
 </p>
@@ -38,24 +38,17 @@
 
 ---
 
-## 文档（组件库源码只有一份！技术栈不同，给出如下文档示例）
+## 文档
 
-> 组件库源码只有一份！技术栈不同，给出如下文档说明
-
-更多介绍，请访问。
-
-- [Vue Doc](https://vue-quarkd.hellobike.com)
-- [React Doc](https://react-quarkd.hellobike.com)
-- [Vanilla Javascript Doc(work in progress...)](https://vanilla-quarkd.hellobike.com)
-- [Angular Doc(work in progress...)](https://angular-quarkd.hellobike.com)
-- [Svelte Doc(work in progress...)](https://svelte-quarkd.hellobike.com)
+完整文档请访问： [https://quark-ecosystem.github.io/quarkd-docs](https://quark-ecosystem.github.io/quarkd-docs).
 
 ## 使用示例
+
 ```js
-import "quarkd/lib/button"
+import "quarkd/lib/button";
 
 // 就像一个普通的 div 标签 `<div>xx</div>`, 可以在任何浏览器被使用
-<quark-button type="primary">Button</quark-button>
+<quark-button type="primary">Button</quark-button>;
 ```
 
 ```html
@@ -66,13 +59,12 @@ import "quarkd/lib/button"
 <quark-button type="primary" @click="onClick">Button</quark-button>
 
 // svelte
-<quark-button type="primary" on:click={onClick}>Button</quark-button>
+<quark-button type="primary" on:click="{onClick}">Button</quark-button>
 
 // angular
 <quark-button type="primary" (click)="onClick">Button</quark-button>
 ```
 
-
 ## Vs Code 插件
 
 [Visual Studio | Marketplace](https://marketplace.visualstudio.com/items?itemName=quarkd.quarkd-vscode-extension)

diff --git a/example/src/sites/doc/components/Header.vue b/example/src/sites/doc/components/Header.vue
@@ -2,12 +2,12 @@
 	<header :class="{ sticky: isHomePage() }" class="header">
 		<div>
 			<a
-				href="https://github.com/hellof2e/vue-quarkd.hellobike.com"
+				href="https://github.com/hellof2e/quarkd-docs-vue"
 				target="_blank"
 				class="top-info"
 			>
 				当前环境：development，代码 PR
-				合并后，文档会自动同步至：https://github.com/hellof2e/${framework}-quarkd.hellobike.com
+				合并后，文档会自动同步至：https://github.com/hellof2e/quarkd-docs-${framework}
 			</a>
 			<div class="container">
 				<div class="left-bar" style="">Quark design 源码调试界面</div>

diff --git a/packages/quark-react/scripts/postinstall.js b/packages/quark-react/scripts/postinstall.js
diff --git a/packages/quarkd/README.md b/packages/quarkd/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://quarkc.hellobike.com/">
+  <a href="https://quark-ecosystem.github.io/quarkd-docs">
     <img src="https://github.com/hellof2e/quark-design/assets/14307551/45ca3969-3f92-49a1-84fa-a4e6160cb7f4" />
   </a>
 </p>
@@ -12,6 +12,8 @@ Next-gen frontend component library, it can be used in any framework or no frame
 
 </div>
 
+哈啰集团面向 C 端 UI 组件库，支撑哈啰几乎所有 C 端 H5 项目，包括交易，支付，两轮，商城等。这是一个设计轻盈优雅的企业级 UI 组件库，可以满足日常所需所有基础组件，且支持跨技术栈运行。
+
 <p align="center">
   <a href="https://www.npmjs.com/package/quarkd"><img src="https://img.shields.io/npm/dt/quarkd.svg" alt="Total Downloads"></a>
   <a href="https://www.npmjs.com/package/quarkd">
@@ -34,7 +36,42 @@ Next-gen frontend component library, it can be used in any framework or no frame
 
 ## Documentation
 
-For full documentation, visit [quarkc.hellobike.com](https://quarkc.hellobike.com)
+For full documentation, visit [https://quark-ecosystem.github.io/quarkd-docs](https://quark-ecosystem.github.io/quarkd-docs).
+
+## Install
+
+```bash
+npm install quarkd
+```
+
+## Usage example
+
+```jsx
+import "quarkd/lib/button";
+
+// like a normal div tag `<div>xx</div>`, can be used in any browser.
+<quark-button type="primary" onclick="onClick">
+  Button
+</quark-button>;
+```
+
+```html
+// react
+<quark-button type="primary" onClick="onClick">Button</quark-button>
+
+// vue
+<quark-button type="primary" @click="onClick">Button</quark-button>
+
+// svelte
+<quark-button type="primary" on:click="{onClick}">Button</quark-button>
+
+// angular
+<quark-button type="primary" (click)="onClick">Button</quark-button>
+```
+
+## Vs Code plugin
+
+[Visual Studio | Marketplace](https://marketplace.visualstudio.com/items?itemName=quarkd.quarkd-vscode-extension)
 
 ## Community
 

diff --git a/packages/quarkd/README.zh-CN.md b/packages/quarkd/README.zh-CN.md
@@ -0,0 +1,80 @@
+<p align="center">
+  <a href="https://quark-ecosystem.github.io/quarkc-docs">
+    <img width="120" src="https://user-images.githubusercontent.com/14307551/197440754-08db4379-eb0f-4808-890d-690355e6e8d2.png">
+  </a>
+</p>
+
+<h1 align="center">Quark Design</h1>
+
+<div align="center">
+
+下一代前端组件库，它可以在任意框架或无框架中使用。
+
+</div>
+
+哈啰集团面向 C 端 UI 组件库，支撑哈啰几乎所有 C 端 H5 项目，包括交易，支付，两轮，商城等。这是一个设计轻盈优雅的企业级 UI 组件库，可以满足所有日常使用的基础组件需求。
+
+<p align="center">
+  <a href="http://makeapullrequest.com">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome">
+  </a>
+  <a href="https://www.npmjs.com/package/quarkd">
+    <img src="https://img.shields.io/npm/v/quarkd.svg" alt="Published on NPM">
+  </a>
+  <a href="https://github.com/hellof2e/quark-design">
+    <img src="https://img.shields.io/github/contributors/hellof2e/quark-design" alt="contributors">
+  </a>
+  <a href="https://github.com/hellof2e/quark-design/blob/main/LICENSE">
+    <img src="https://img.shields.io/npm/l/quark-design.svg" alt="License">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/hellof2e/quark-design/blob/main/README.md">
+  English |
+  </a>
+  <span>简体中文</span>
+</p>
+
+---
+
+## 文档
+
+完整文档请访问： [https://quark-ecosystem.github.io/quarkd-docs](https://quark-ecosystem.github.io/quarkd-docs).
+
+## 使用示例
+
+```js
+import "quarkd/lib/button";
+
+// 就像一个普通的 div 标签 `<div>xx</div>`, 可以在任何浏览器被使用
+<quark-button type="primary">Button</quark-button>;
+```
+
+```html
+// react
+<quark-button type="primary" onClick="onClick">Button</quark-button>
+
+// vue
+<quark-button type="primary" @click="onClick">Button</quark-button>
+
+// svelte
+<quark-button type="primary" on:click="{onClick}">Button</quark-button>
+
+// angular
+<quark-button type="primary" (click)="onClick">Button</quark-button>
+```
+
+## Vs Code 插件
+
+[Visual Studio | Marketplace](https://marketplace.visualstudio.com/items?itemName=quarkd.quarkd-vscode-extension)
+
+## 社区交流
+
+如需帮助、讨论最佳实践或任何其他可从可搜索中获益的对话：
+
+[Discuss Quark design on Github](https://github.com/hellof2e/quark-design/discussions)
+
+## 贡献者
+
+如果您有兴趣为 Quark design 做出贡献，请阅读我们的 [contributing docs](https://github.com/hellof2e/quark-design/blob/main/CONTRIBUTING.md) **在提交 PR 之前**.
diff --git a/packages/quarkd/src/rate/demo.vue b/packages/quarkd/src/rate/demo.vue
@@ -24,7 +24,7 @@
     <div class="tag-container">
       <quark-rate
         defaultvalue="2"
-        imgicon="https://vue-quarkd.hellobike.com/assets/quark-logo.f9a6a307.png"
+        imgicon="https://raw.githubusercontent.com/hellof2e/static/main/quark-logo.png"
       >
       </quark-rate>
     </div>

diff --git a/packages/quarkd/src/rate/doc-react.en-US.md b/packages/quarkd/src/rate/doc-react.en-US.md
@@ -57,7 +57,7 @@ export default () => {
 ```html
 <Rate
   value="2"
-  imgicon="https://vue-quarkd.hellobike.com/assets/quark-logo.f9a6a307.png"
+  imgicon="https://raw.githubusercontent.com/hellof2e/static/main/quark-logo.png"
 ></Rate>
 ```
 

diff --git a/packages/quarkd/src/rate/doc-react.zh-CN.md b/packages/quarkd/src/rate/doc-react.zh-CN.md
@@ -57,7 +57,7 @@ export default () => {
 ```html
 <Rate
   value="2"
-  imgicon="https://vue-quarkd.hellobike.com/assets/quark-logo.f9a6a307.png"
+  imgicon="https://raw.githubusercontent.com/hellof2e/static/main/quark-logo.png"
 ></Rate>
 ```
 

diff --git a/packages/quarkd/src/rate/doc.en-US.md b/packages/quarkd/src/rate/doc.en-US.md
@@ -56,7 +56,7 @@ quark-rate {
 ```html
 <quark-rate
   defaultvalue="2"
-  imgicon="https://vue-quarkd.hellobike.com/assets/quark-logo.f9a6a307.png"
+  imgicon="https://raw.githubusercontent.com/hellof2e/static/main/quark-logo.png"
 ></quark-rate>
 ```
 

diff --git a/packages/quarkd/src/rate/doc.zh-CN.md b/packages/quarkd/src/rate/doc.zh-CN.md
@@ -56,7 +56,7 @@ quark-rate {
 ```html
 <quark-rate
   defaultvalue="2"
-  imgicon="https://vue-quarkd.hellobike.com/assets/quark-logo.f9a6a307.png"
+  imgicon="https://raw.githubusercontent.com/hellof2e/static/main/quark-logo.png"
 ></quark-rate>
 ```
 

diff --git a/packages/vscode-extension/src/extension.ts b/packages/vscode-extension/src/extension.ts
@@ -3,7 +3,8 @@ import { kebabCase, bigCamelize } from "./utils";
 import { componentMap } from "./componentMap";
 import { ComponentDesc } from "./componentDesc";
 
-const VUEDOC = "https://vue-quarkd.hellobike.com/#/zh-CN/component";
+const VUEDOC =
+  "https://quark-ecosystem.github.io/quarkd-docs/vue/#/zh-CN/component/button";
 
 const LINK_REG = /(?<=<quark-)([\w-]+)/g;
 const BIG_LINK_REG = /(?<=<Quark-)([\w-])+/g;

diff --git a/scripts/copydocs2react.js b/scripts/copydocs2react.js
@@ -89,7 +89,8 @@ const copy = async () => {
     docsConfig.version = fromPkgConfig.version;
     docsConfig.nav = fromConfig.nav;
     docsConfig.docs = fromConfig.docs;
-    docsConfig.demoUrl = "https://quark-design.hellobike.com/demo/demo.html#";
+    docsConfig.demoUrl =
+      "https://quark-ecosystem.github.io/quarkd-docs/h5/demo";
     fse
       .writeJson(quarkdDocsConfigPath, docsConfig, {
         spaces: 2,

diff --git a/scripts/copydocs2vue.js b/scripts/copydocs2vue.js
@@ -84,7 +84,8 @@ const copy = async () => {
     docsConfig.version = fromPkgConfig.version;
     docsConfig.nav = fromConfig.nav;
     docsConfig.docs = fromConfig.docs;
-    docsConfig.demoUrl = "https://quark-design.hellobike.com/demo/demo.html#";
+    docsConfig.demoUrl =
+      "https://quark-ecosystem.github.io/quarkd-docs/h5/demo";
     fse
       .writeJson(quarkdDocsConfigPath, docsConfig, {
         spaces: 2,