Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xsf0105 committed Aug 20, 2024
1 parent 75772f3 commit b74dac7
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 53 deletions.
45 changes: 19 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,6 @@ Quarkc 无框架,前端构建工具。
<a href="https://stackblitz.com/edit/quarkc-vite-k6t2ge?file=index.html&file=src%2Findex.tsx"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
</p>



### 联系我们

添加微信:Sanqi9675


### 优秀案例

| 作者 | github 地址 | 截图 / 链接
| ---- | ---- | ----- |
| @yuhaiyang1 | https://github.com/yuhaiyang1/quarkc-time | https://unpkg.com/quark-timer@0.0.2/demo.html |
| @khno | https://github.com/khno/quark-element-demo-celebrate | https://unpkg.com/quarkc-demo-celebrate@latest/demo.html |
| @hellof2e | https://github.com/hellof2e/quark-doc-header | ![1685501041275](https://github.com/hellof2e/quark-core/assets/14307551/24dd5626-e6a9-452c-9c95-c2cdb8891573) https://quarkc.hellobike.com/#/ |
| @xsf0105 | https://github.com/xsf0105/dark-light-element | https://unpkg.com/dark-light-element@latest/demo.html |
| @dyf19118 | https://github.com/dyf19118/quark-ui-rate | ![image](https://github.com/hellof2e/quark-cli/assets/14307551/e11e6c49-4c18-4bca-adc3-01a7198ab2e2) |
| @hellof2e | https://github.com/hellof2e/quark-doc-home | ![1686575964690](https://github.com/hellof2e/quark-core/assets/14307551/9618427c-916b-4dfd-b28b-0e8e0f6ce744) |
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |



## 介绍

Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工具(jsx + web components)。通过它,您可以开发标准的**跨框架组件****独立前端应用**(脱离框架的原生web应用,性能可达百分百💯)。
Expand All @@ -62,7 +41,6 @@ Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工
* 组件直接解耦,独立打磨,按需引用



## 使用

### 1、创建组件构建模版工程
Expand Down Expand Up @@ -189,11 +167,26 @@ export default defineConfig({
</html>
```

### 组件发布

更多发布相关,详情点击 [发布 Publishing](https://quark-ecosystem.github.io/quarkc-docs/#/zh-CN/docs/publishing)
## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)


### 联系我们

添加微信:Sanqi9675


### 社区示例

| 作者 | github 地址 | 截图 / 链接
| ---- | ---- | ----- |
| @xsf0105 | https://github.com/xsf0105/dark-light-element | https://unpkg.com/dark-light-element@latest/demo.html |
| @hellof2e | https://github.com/hellof2e/quark-doc-header | ![1685501041275](https://github.com/hellof2e/quark-core/assets/14307551/24dd5626-e6a9-452c-9c95-c2cdb8891573) https://quarkc.hellobike.com/#/ |
| @yuhaiyang1 | https://github.com/yuhaiyang1/quarkc-time | https://unpkg.com/quark-timer@0.0.2/demo.html |
| @dyf19118 | https://github.com/dyf19118/quark-ui-rate | ![image](https://github.com/hellof2e/quark-cli/assets/14307551/e11e6c49-4c18-4bca-adc3-01a7198ab2e2) |
| @hellof2e | https://github.com/hellof2e/quark-doc-home | ![1686575964690](https://github.com/hellof2e/quark-core/assets/14307551/9618427c-916b-4dfd-b28b-0e8e0f6ce744) |
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |

## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)
45 changes: 19 additions & 26 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,6 @@ Quarkc 无框架,前端构建工具。
<a href="https://stackblitz.com/edit/quarkc-vite-k6t2ge?file=index.html&file=src%2Findex.tsx"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt=""></a>
</p>



### 联系我们

添加微信:Sanqi9675


### 优秀案例

| 作者 | github 地址 | 截图 / 链接
| ---- | ---- | ----- |
| @yuhaiyang1 | https://github.com/yuhaiyang1/quarkc-time | https://unpkg.com/quark-timer@0.0.2/demo.html |
| @khno | https://github.com/khno/quark-element-demo-celebrate | https://unpkg.com/quarkc-demo-celebrate@latest/demo.html |
| @hellof2e | https://github.com/hellof2e/quark-doc-header | ![1685501041275](https://github.com/hellof2e/quark-core/assets/14307551/24dd5626-e6a9-452c-9c95-c2cdb8891573) https://quarkc.hellobike.com/#/ |
| @xsf0105 | https://github.com/xsf0105/dark-light-element | https://unpkg.com/dark-light-element@latest/demo.html |
| @dyf19118 | https://github.com/dyf19118/quark-ui-rate | ![image](https://github.com/hellof2e/quark-cli/assets/14307551/e11e6c49-4c18-4bca-adc3-01a7198ab2e2) |
| @hellof2e | https://github.com/hellof2e/quark-doc-home | ![1686575964690](https://github.com/hellof2e/quark-core/assets/14307551/9618427c-916b-4dfd-b28b-0e8e0f6ce744) |
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |



## 介绍

Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工具(jsx + web components)。通过它,您可以开发标准的**跨框架组件****独立前端应用**(脱离框架的原生web应用,性能可达百分百💯)。
Expand All @@ -62,7 +41,6 @@ Quarkc(Quark core缩写) 是一个拥有完美开发体验的 web components 工
* 组件直接解耦,独立打磨,按需引用



## 使用

### 1、创建组件构建模版工程
Expand Down Expand Up @@ -189,11 +167,26 @@ export default defineConfig({
</html>
```

### 组件发布

更多发布相关,详情点击 [发布 Publishing](https://quark-ecosystem.github.io/quarkc-docs/#/zh-CN/docs/publishing)
## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)


### 联系我们

添加微信:Sanqi9675


### 社区示例

| 作者 | github 地址 | 截图 / 链接
| ---- | ---- | ----- |
| @xsf0105 | https://github.com/xsf0105/dark-light-element | https://unpkg.com/dark-light-element@latest/demo.html |
| @hellof2e | https://github.com/hellof2e/quark-doc-header | ![1685501041275](https://github.com/hellof2e/quark-core/assets/14307551/24dd5626-e6a9-452c-9c95-c2cdb8891573) https://quarkc.hellobike.com/#/ |
| @yuhaiyang1 | https://github.com/yuhaiyang1/quarkc-time | https://unpkg.com/quark-timer@0.0.2/demo.html |
| @dyf19118 | https://github.com/dyf19118/quark-ui-rate | ![image](https://github.com/hellof2e/quark-cli/assets/14307551/e11e6c49-4c18-4bca-adc3-01a7198ab2e2) |
| @hellof2e | https://github.com/hellof2e/quark-doc-home | ![1686575964690](https://github.com/hellof2e/quark-core/assets/14307551/9618427c-916b-4dfd-b28b-0e8e0f6ce744) |
| @zhangfisher | https://github.com/zhangfisher/lite-tree/tree/master/packages/quark | [点击查看](https://github.com/zhangfisher/lite-tree/blob/master/docs/tree.png?raw=true) |

## 文档

完整文档,请访问 [quarkc.hellobike.com](https://quark-ecosystem.github.io/quarkc-docs)
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "quarkc",
"version": "2.1.4",
"version": "2.1.6",
"description": "A Web Components framework",
"type": "module",
"module": "./lib/index.js",
Expand Down

0 comments on commit b74dac7

Please sign in to comment.