Skip to content

Commit

Permalink
docs: move to cloudflare
Browse files Browse the repository at this point in the history
  • Loading branch information
haoziqaq committed May 7, 2024
1 parent 78d19d1 commit 9a3bdb4
Show file tree
Hide file tree
Showing 35 changed files with 259 additions and 255 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<div align="center">
<a href="https://varletjs.github.io/varlet/#/en-US/index">
<img src="https://varletjs.github.io/varlet/logo.svg" width="150">
<a href="https://varlet.pages.dev/#/en-US/index">
<img src="https://varlet.pages.dev/logo.svg" width="150">
</a>
<h1>VARLET</h1>
<p>A mobile component library based on Vue3, Material Design 2, Material Design 3, and supports desktop development.</p>
<p>
<a href="https://varlet.pages.dev/#/en-US/index">Documentation(Cloudflare)</a> |
<a href="https://varlet-varletjs.vercel.app/#/en-US/index">Documentation(Vercel)</a> |
<a href="https://varletjs.github.io/varlet/#/en-US/index">Documentation(Github)</a> |
<a href="https://github.com/varletjs/varlet/blob/dev/README.zh-CN.md">中文README</a>
Expand Down
5 changes: 3 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@

<div align="center">
<a href="https://varletjs.github.io/varlet">
<img src="https://varletjs.github.io/varlet/logo.svg" width="150">
<a href="https://varlet.pages.dev">
<img src="https://varlet.pages.dev/logo.svg" width="150">
</a>
<h1>VARLET</h1>
<p>一个移动端组件库,基于 Vue3, Material Design 2, Material Design 3,并支持桌面端开发。</p>
<p>
<a href="https://varlet.pages.dev">文档(Cloudflare)</a> |
<a href="https://varlet-varletjs.vercel.app">文档(Vercel)</a> |
<a href="https://varletjs.github.io/varlet">文档(Github)</a> |
<a href="https://github.com/varletjs/varlet/blob/dev/README.md">ENGLISH README</a>
Expand Down
6 changes: 3 additions & 3 deletions packages/varlet-cli/src/node/config/varlet.default.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,15 +429,15 @@ export default defineConfig({
currentVersion: 'v3.x',
versions: [
{
name: 'varlet.gitee.io',
name: 'varlet.pages.dev',
items: [
{
label: 'v3.x',
link: 'https://varletjs.github.io/varlet',
link: 'https://varlet.pages.dev',
},
{
label: 'v2.x',
link: 'https://varletjs.github.io/varlet/v2',
link: 'https://varlet.pages.dev/v2',
},
],
},
Expand Down
5 changes: 3 additions & 2 deletions packages/varlet-ui/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<div align="center">
<a href="https://varletjs.github.io/varlet/#/en-US/index">
<img src="https://varletjs.github.io/varlet/logo.svg" width="150">
<a href="https://varlet.pages.dev/#/en-US/index">
<img src="https://varlet.pages.dev/logo.svg" width="150">
</a>
<h1>VARLET</h1>
<p>A mobile component library based on Vue3, Material Design 2, Material Design 3, and supports desktop development.</p>
<p>
<a href="https://varlet.pages.dev/#/en-US/index">Documentation(Cloudflare)</a> |
<a href="https://varlet-varletjs.vercel.app/#/en-US/index">Documentation(Vercel)</a> |
<a href="https://varletjs.github.io/varlet/#/en-US/index">Documentation(Github)</a> |
<a href="https://github.com/varletjs/varlet/blob/dev/README.zh-CN.md">中文README</a>
Expand Down
5 changes: 3 additions & 2 deletions packages/varlet-ui/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@

<div align="center">
<a href="https://varletjs.github.io/varlet">
<img src="https://varletjs.github.io/varlet/logo.svg" width="150">
<a href="https://varlet.pages.dev">
<img src="https://varlet.pages.dev/logo.svg" width="150">
</a>
<h1>VARLET</h1>
<p>一个移动端组件库,基于 Vue3, Material Design 2, Material Design 3,并支持桌面端开发。</p>
<p>
<a href="https://varlet.pages.dev">文档(Cloudflare)</a> |
<a href="https://varlet-varletjs.vercel.app">文档(Vercel)</a> |
<a href="https://varletjs.github.io/varlet">文档(Github)</a> |
<a href="https://github.com/varletjs/varlet/blob/dev/README.md">ENGLISH README</a>
Expand Down
4 changes: 2 additions & 2 deletions packages/varlet-ui/docs/designResources.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ We provide design resources for designers, you can select the required resources

Component resources include `color`, `text`, and `component resources`. At present, only the design resources of the Material Design 2 light color mode are provided, and the dark mode is not yet available. Community contributions are welcome.

<img src="https://varletjs.github.io/varlet/design/components.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/design/components.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

```vue
import ComponentResourcesDownload from './components/ComponentResourcesDownload.vue'
Expand All @@ -18,7 +18,7 @@ import ComponentResourcesDownload from './components/ComponentResourcesDownload.

The icon resource contains `100+` icons built into the component library.

<img src="https://varletjs.github.io/varlet/design/icons.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/design/icons.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

```vue
import IconResourcesDownload from './components/IconResourcesDownload.vue'
Expand Down
4 changes: 2 additions & 2 deletions packages/varlet-ui/docs/designResources.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

组件资源包含了`色彩``文字``组件资源`。目前只提供 Material Design 2 亮色模式的设计资源,其他资源暂未提供,欢迎社区贡献。

<img src="https://varletjs.github.io/varlet/design/components.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/design/components.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

```vue
import ComponentResourcesDownload from './components/ComponentResourcesDownload.vue'
Expand All @@ -18,7 +18,7 @@ import ComponentResourcesDownload from './components/ComponentResourcesDownload.

图标资源包含了组件库内置的 `100+` 图标。

<img src="https://varletjs.github.io/varlet/design/icons.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/design/icons.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

```vue
import IconResourcesDownload from './components/IconResourcesDownload.vue'
Expand Down
14 changes: 7 additions & 7 deletions packages/varlet-ui/docs/extension.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ VsCode Extension Marketplace Search [varlet-vscode-extension](https://marketplac

Grammatical hints appear when you enter the keyword of the component name, and you can quickly complete it after selecting it.

<img src="https://varletjs.github.io/varlet/vscode/1.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/1.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

Moving the mouse to the component name will display the document address of the component, which can be clicked to jump, and it also directly displays the properties, events and slots of the component in the form of a table.

<img src="https://varletjs.github.io/varlet/vscode/2.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/2.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

Press space or attribute keywords in the attribute input range of the label to display attribute completion prompts and attribute information.

<img src="https://varletjs.github.io/varlet/vscode/3.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/3.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

When the `name` property of the `Icon` component is input, an icon preview will appear, and syntax completion will be performed after selection.

<img src="https://varletjs.github.io/varlet/vscode/4.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/4.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

Frame the code snippet, and you can quickly open `Playground` in the right-click menu to preview the framed code online.

<img src="https://varletjs.github.io/varlet/vscode/7.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/7.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

Support switching between Chinese and English, more friendly to Chinese people.

<img src="https://varletjs.github.io/varlet/vscode/5.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varletjs.github.io/varlet/vscode/6.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 10px">
<img src="https://varlet.pages.dev/vscode/5.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/6.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 10px">
14 changes: 7 additions & 7 deletions packages/varlet-ui/docs/extension.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,26 @@ VsCode 插件市场搜索 [varlet-vscode-extension](https://marketplace.visualst

输入组件名称关键字时出现语法提示,选中后进行快速补全。

<img src="https://varletjs.github.io/varlet/vscode/1.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/1.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

鼠标移动到组件名会显示组件的文档地址用来点击跳转,也直接以表格的形式展示组件的属性、事件和插槽。

<img src="https://varletjs.github.io/varlet/vscode/2.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/2.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

在标签的属性输入范围按下空格或属性关键字,显示属性补全提示和属性信息。

<img src="https://varletjs.github.io/varlet/vscode/3.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/3.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

输入 `Icon` 组件的 `name` 属性时出现图标预览,选中后进行语法补全。

<img src="https://varletjs.github.io/varlet/vscode/4.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/4.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

框选代码片段,右键菜单中可以快速打开 `Playground` 对框选的代码进行线上预览。

<img src="https://varletjs.github.io/varlet/vscode/7.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/7.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">

支持中英文切换,对中国人更加友好。

<img src="https://varletjs.github.io/varlet/vscode/5.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varletjs.github.io/varlet/vscode/6.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 10px">
<img src="https://varlet.pages.dev/vscode/5.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 16px">
<img src="https://varlet.pages.dev/vscode/6.png" style="width: 100%; display: block; border-radius: 4px; margin-top: 10px">

2 changes: 1 addition & 1 deletion packages/varlet-ui/docs/quickstart.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Details see [here](#/en-US/browserAdaptation).
We provide a web version of the component editor,
which is convenient for you to quickly get started with each component of the component library,
edit it online, share it with others, or download the code package to run locally.
You can click the `{...}` icon in the upper right corner of the page or [go here](https://varletjs.github.io/varlet/playground).
You can click the `{...}` icon in the upper right corner of the page or [go here](https://varlet.pages.dev/playground).
2 changes: 1 addition & 1 deletion packages/varlet-ui/docs/quickstart.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ body {
### 在线体验组件

我们提供了网页版的组件编辑器,方便您对组件库的各个组件进行快速上手、在线编辑、分享给他人或是下载代码包本地运行。
您可以点击网页右上角的 `{...}` 图标或是 [这里前往](https://varletjs.github.io/varlet/playground)
您可以点击网页右上角的 `{...}` 图标或是 [这里前往](https://varlet.pages.dev/playground)
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/app-bar/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const active = ref(0)
<template>
<var-app-bar
round
image="https://varletjs.github.io/varlet/tree.jpeg"
image="https://varlet.pages.dev/tree.jpeg"
image-linear-gradient="to right top, rgba(29, 68, 147, 0.5) 0%, rgba(74, 198, 170, 0.9) 100%"
>
Title
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/app-bar/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ const active = ref(0)
<template>
<var-app-bar
round
image="https://varletjs.github.io/varlet/tree.jpeg"
image="https://varlet.pages.dev/tree.jpeg"
image-linear-gradient="to right top, rgba(29, 68, 147, 0.5) 0%, rgba(74, 198, 170, 0.9) 100%"
>
标题
Expand Down
42 changes: 21 additions & 21 deletions packages/varlet-ui/src/avatar/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Used as avatar display, supporting images, icons and characters.
```html
<template>
<var-space align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" size="mini" />
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" size="small" />
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" />
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" size="large" />
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" :size="78" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" size="mini" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" size="small" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" size="large" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" :size="78" />
</var-space>
</template>
```
Expand All @@ -23,8 +23,8 @@ Used as avatar display, supporting images, icons and characters.
```html
<template>
<var-space>
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" />
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" :round="false" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" :round="false" />
</var-space>
</template>
```
Expand All @@ -35,23 +35,23 @@ Used as avatar display, supporting images, icons and characters.
<template>
<var-space>
<var-space direction="column" align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" />
<span>cover</span>
</var-space>
<var-space direction="column" align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" fit="fill" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" fit="fill" />
<span>fill</span>
</var-space>
<var-space direction="column" align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" fit="contain" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" fit="contain" />
<span>contain</span>
</var-space>
<var-space direction="column" align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" fit="none" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" fit="none" />
<span>none</span>
</var-space>
<var-space direction="column" align="center">
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" fit="scale-down" />
<var-avatar src="https://varlet.pages.dev/cat.jpg" fit="scale-down" />
<span>scale-down</span>
</var-space>
</var-space>
Expand Down Expand Up @@ -96,9 +96,9 @@ const text = ref('VARLET')
```html
<template>
<var-avatar-group>
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" bordered />
<var-avatar src="https://varletjs.github.io/varlet/cat2.jpg" bordered />
<var-avatar src="https://varletjs.github.io/varlet/cat3.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat2.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat3.jpg" bordered />
<var-avatar bordered>+2</var-avatar>
</var-avatar-group>
</template>
Expand All @@ -109,9 +109,9 @@ const text = ref('VARLET')
```html
<template>
<var-avatar-group vertical>
<var-avatar src="https://varletjs.github.io/varlet/cat.jpg" bordered />
<var-avatar src="https://varletjs.github.io/varlet/cat2.jpg" bordered />
<var-avatar src="https://varletjs.github.io/varlet/cat3.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat2.jpg" bordered />
<var-avatar src="https://varlet.pages.dev/cat3.jpg" bordered />
<var-avatar bordered>+2</var-avatar>
</var-avatar-group>
</template>
Expand All @@ -122,9 +122,9 @@ const text = ref('VARLET')
```html
<template>
<var-avatar-group>
<var-avatar hoverable src="https://varletjs.github.io/varlet/cat.jpg" />
<var-avatar hoverable src="https://varletjs.github.io/varlet/cat2.jpg" />
<var-avatar hoverable src="https://varletjs.github.io/varlet/cat3.jpg" />
<var-avatar hoverable src="https://varlet.pages.dev/cat.jpg" />
<var-avatar hoverable src="https://varlet.pages.dev/cat2.jpg" />
<var-avatar hoverable src="https://varlet.pages.dev/cat3.jpg" />
<var-avatar hoverable bordered>+2</var-avatar>
</var-avatar-group>
</template>
Expand Down
Loading

0 comments on commit 9a3bdb4

Please sign in to comment.