diff --git a/.github/ISSUE_TEMPLATE/feature-report.zh-CN.yml b/.github/ISSUE_TEMPLATE/feature-report.zh-CN.yml index 390bec80..eb13c77b 100644 --- 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 index 8b29cc47..fdb9fda0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- +

@@ -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 `
xx
`, can be used in any browser. -Button + + Button +; ``` ```html @@ -61,7 +63,7 @@ import "quarkd/lib/button"; Button // svelte -Button +Button // angular 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 index 57daa49c..08a1e460 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,5 +1,5 @@

- +

@@ -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 标签 `
xx
`, 可以在任何浏览器被使用 -Button +Button; ``` ```html @@ -66,13 +59,12 @@ import "quarkd/lib/button" Button // svelte -Button +Button // angular 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 index 1e5635d4..9f8d7a65 100644 --- a/example/src/sites/doc/components/Header.vue +++ b/example/src/sites/doc/components/Header.vue @@ -2,12 +2,12 @@
当前环境：development，代码 PR - 合并后，文档会自动同步至：https://github.com/hellof2e/${framework}-quarkd.hellobike.com + 合并后，文档会自动同步至：https://github.com/hellof2e/quarkd-docs-${framework}
Quark design 源码调试界面
diff --git a/packages/quark-react/scripts/postinstall.js b/packages/quark-react/scripts/postinstall.js deleted file mode 100644 index 176bf7cd..00000000 --- a/packages/quark-react/scripts/postinstall.js +++ /dev/null @@ -1,59 +0,0 @@ -const fs = require("fs-extra"); -const path = require("path"); -const https = require("https"); - -const packageRoot = path.join(`${process.cwd()}`, "../../package.json"); -function getInfoFromPackage() { - let packageInfo = fs.readFileSync(packageRoot, "utf8"); - packageInfo = JSON.parse(packageInfo); - - // 读取 AppName - const appName = packageInfo["name"] || "Undefined"; - // 读取 Quark 版本 - const libVersion = packageInfo["dependencies"]["quark-react"] || "Undefined"; - - return { - appName, - libVersion, - techStack: "react", - appDesc: "desc", - }; -} - -function postPackageInfo() { - let packageInfo = undefined; - try { - packageInfo = getInfoFromPackage(); - } catch { - return; - } - const data = JSON.stringify({ - ...packageInfo, - }); - const options = { - hostname: "fat-123-server.hellobike.cn", - port: 443, - path: "/api/v1/createQuark", - method: "POST", - headers: { - "Content-Type": "application/json", - "Content-Length": data.length, - }, - }; - const req = https.request(options, (res) => { - console.log(`Quark 使用统计上报状态码: ${res.statusCode}`); - console.log(`Quark 使用文档: https://quark.hellobike.cn/#/`); - // res.on('data', d => { - // process.stdout.write(d) - // }) - }); - - req.on("error", (error) => { - console.error(error); - }); - - req.write(data); - req.end(); -} - -postPackageInfo(); diff --git a/packages/quarkd/README.md b/packages/quarkd/README.md index 4148357e..fdb9fda0 100644 --- a/packages/quarkd/README.md +++ b/packages/quarkd/README.md @@ -1,5 +1,5 @@

- +

@@ -12,6 +12,8 @@ Next-gen frontend component library, it can be used in any framework or no frame
+哈啰集团面向 C 端 UI 组件库，支撑哈啰几乎所有 C 端 H5 项目，包括交易，支付，两轮，商城等。这是一个设计轻盈优雅的企业级 UI 组件库，可以满足日常所需所有基础组件，且支持跨技术栈运行。 +

Total Downloads @@ -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 `

xx
`, can be used in any browser. + + Button +; +``` + +```html +// react +Button + +// vue +Button + +// svelte +Button + +// angular +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 new file mode 100644 index 00000000..08a1e460 --- /dev/null +++ b/packages/quarkd/README.zh-CN.md @@ -0,0 +1,80 @@ +

+ + + +

+ +

Quark Design

+ +
+ +下一代前端组件库，它可以在任意框架或无框架中使用。 + +
+ +哈啰集团面向 C 端 UI 组件库，支撑哈啰几乎所有 C 端 H5 项目，包括交易，支付，两轮，商城等。这是一个设计轻盈优雅的企业级 UI 组件库，可以满足所有日常使用的基础组件需求。 + +

+ + PRs Welcome + + + Published on NPM + + + contributors + + + License + +

+ +

+ + English | + + 简体中文 +

+ +--- + +## 文档 + +完整文档请访问： [https://quark-ecosystem.github.io/quarkd-docs](https://quark-ecosystem.github.io/quarkd-docs). + +## 使用示例 + +```js +import "quarkd/lib/button"; + +// 就像一个普通的 div 标签 `
xx
`, 可以在任何浏览器被使用 +Button; +``` + +```html +// react +Button + +// vue +Button + +// svelte +Button + +// angular +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 index 90a7f241..0ebab8b8 100644 --- a/packages/quarkd/src/rate/demo.vue +++ b/packages/quarkd/src/rate/demo.vue @@ -24,7 +24,7 @@
diff --git a/packages/quarkd/src/rate/doc-react.en-US.md b/packages/quarkd/src/rate/doc-react.en-US.md index feb197b9..66fb0144 100644 --- 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 ``` diff --git a/packages/quarkd/src/rate/doc-react.zh-CN.md b/packages/quarkd/src/rate/doc-react.zh-CN.md index adc0a6dc..a4f8f2f5 100644 --- 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 ``` diff --git a/packages/quarkd/src/rate/doc.en-US.md b/packages/quarkd/src/rate/doc.en-US.md index 17ddc1dc..a7a36b62 100644 --- 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 ``` diff --git a/packages/quarkd/src/rate/doc.zh-CN.md b/packages/quarkd/src/rate/doc.zh-CN.md index f7a24a76..b13e5d34 100644 --- 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 ``` diff --git a/packages/vscode-extension/src/extension.ts b/packages/vscode-extension/src/extension.ts index 5385cc53..faff7eda 100644 --- 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 = /(?<= { 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 index 3a001754..cc506e08 100644 --- 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,