Skip to content

Commit edead4b

Browse files
yequanruiyequanrui
committedAug 4, 2024·
add docs
1 parent b353f30 commit edead4b

15 files changed

+1094
-142
lines changed
 

‎.editorconfig

+3
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ insert_final_newline = true
3737
## 设置为true以删除换行符之前的任何空格字符，设置为false以确保不会。
3838
trim_trailing_whitespace = true
3939

40+
[*.ts]
41+
quote_type = single
42+
4043
[*.md]
4144
max_line_length = off
4245
trim_trailing_whitespace = false

‎.github/workflows/deploy.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# 在针对 main 分支的推送上运行。
7+
# 如果你使用 master 分支作为默认分支，请将其更改为 master
8+
push:
9+
branches: [main, master]
10+
11+
# 允许你从 Actions 选项卡手动运行此工作流程
12+
workflow_dispatch:
13+
14+
# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
21+
# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# 构建工作
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
35+
- uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消注释
36+
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
37+
- name: Setup Node
38+
uses: actions/setup-node@v4
39+
with:
40+
node-version: 20
41+
cache: pnpm # npm / pnpm / yarn
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v4
44+
- name: Install dependencies
45+
run: pnpm install # npm ci / pnpm install / yarn install / bun install
46+
- name: Build with VitePress
47+
run: pnpm docs:build # npm run docs:build / pnpm docs:build / yarn docs:build / bun run docs:build
48+
- name: Upload artifact
49+
uses: actions/upload-pages-artifact@v3
50+
with:
51+
path: .vitepress/dist
52+
53+
# 部署工作
54+
deploy:
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
needs: build
59+
runs-on: ubuntu-latest
60+
name: Deploy
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4

‎.gitignore

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
node_modules
2-
dist
3-
out
42
.DS_Store
53
*.log*
4+
dist
5+
out
6+
.vitepress/cache
7+
.vitepress/dist

‎.prettierignore

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
out
2-
dist
31
pnpm-lock.yaml
4-
LICENSE.md
5-
tsconfig.json
6-
tsconfig.*.json
2+
node_modules
3+
dist
4+
out
5+
.vitepress/cache
6+
.vitepress/dist

‎.vitepress/config.mjs

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import { defineConfig } from 'vitepress';
2+
import config from '../package.json';
3+
4+
// https://vitepress.dev/reference/site-config
5+
export default defineConfig({
6+
title: config.productName,
7+
description: config.description,
8+
base: `/${config.productName}/`,
9+
srcDir: 'docs',
10+
themeConfig: {
11+
// https://vitepress.dev/reference/default-theme-config
12+
nav: [
13+
{ text: 'Home', link: '/' },
14+
{ text: 'Examples', link: '/markdown-examples' },
15+
],
16+
sidebar: [
17+
{
18+
text: 'Examples',
19+
items: [
20+
{ text: 'Markdown Examples', link: '/markdown-examples' },
21+
{ text: 'Runtime API Examples', link: '/api-examples' },
22+
],
23+
},
24+
],
25+
socialLinks: [{ icon: 'github', link: config.homepage }],
26+
rewrites: {
27+
'packages/:pkg(.*)': ':pkg/index.md',
28+
},
29+
},
30+
});

‎.vitepress/theme/index.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import DefaultTheme from 'vitepress/theme'
4+
import './style.css'
5+
6+
/** @type {import('vitepress').Theme} */
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
}

‎.vitepress/theme/style.css

+139
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attched to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
/**
133+
* Component: Algolia
134+
* -------------------------------------------------------------------------- */
135+
136+
.DocSearch {
137+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138+
}
139+

‎docs/api-examples.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# Runtime API Examples
6+
7+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
8+
9+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
10+
11+
```md
12+
<script setup>
13+
import { useData } from 'vitepress'
14+
15+
const { theme, page, frontmatter } = useData()
16+
</script>
17+
18+
## Results
19+
20+
### Theme Data
21+
<pre>{{ theme }}</pre>
22+
23+
### Page Data
24+
<pre>{{ page }}</pre>
25+
26+
### Page Frontmatter
27+
<pre>{{ frontmatter }}</pre>
28+
```
29+
30+
<script setup>
31+
import { useData } from 'vitepress'
32+
33+
const { site, theme, page, frontmatter } = useData()
34+
</script>
35+
36+
## Results
37+
38+
### Theme Data
39+
<pre>{{ theme }}</pre>
40+
41+
### Page Data
42+
<pre>{{ page }}</pre>
43+
44+
### Page Frontmatter
45+
<pre>{{ frontmatter }}</pre>
46+
47+
## More
48+
49+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

‎docs/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "WeTools"
7+
text: "WeLink工具箱"
8+
tagline: My great project tagline
9+
actions:
10+
- theme: brand
11+
text: Markdown Examples
12+
link: /markdown-examples
13+
- theme: alt
14+
text: API Examples
15+
link: /api-examples
16+
17+
features:
18+
- title: 蓝版WeLink
19+
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
20+
- title: 红版WeLink 3.x
21+
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
22+
- title: 红版WeLink 7.x
23+
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
24+
---
25+

‎docs/markdown-examples.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Markdown Extension Examples
2+
3+
This page demonstrates some of the built-in markdown extensions provided by VitePress.
4+
5+
## Syntax Highlighting
6+
7+
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
8+
9+
**Input**
10+
11+
````md
12+
```js{4}
13+
export default {
14+
data () {
15+
return {
16+
msg: 'Highlighted!'
17+
}
18+
}
19+
}
20+
```
21+
````
22+
23+
**Output**
24+
25+
```js{4}
26+
export default {
27+
data () {
28+
return {
29+
msg: 'Highlighted!'
30+
}
31+
}
32+
}
33+
```
34+
35+
## Custom Containers
36+
37+
**Input**
38+
39+
```md
40+
::: info
41+
This is an info box.
42+
:::
43+
44+
::: tip
45+
This is a tip.
46+
:::
47+
48+
::: warning
49+
This is a warning.
50+
:::
51+
52+
::: danger
53+
This is a dangerous warning.
54+
:::
55+
56+
::: details
57+
This is a details block.
58+
:::
59+
```
60+
61+
**Output**
62+
63+
::: info
64+
This is an info box.
65+
:::
66+
67+
::: tip
68+
This is a tip.
69+
:::
70+
71+
::: warning
72+
This is a warning.
73+
:::
74+
75+
::: danger
76+
This is a dangerous warning.
77+
:::
78+
79+
::: details
80+
This is a details block.
81+
:::
82+
83+
## More
84+
85+
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

‎docs/packages/[pkg]-[version].md

Whitespace-only changes.

‎docs/packages/[pkg]-[version].paths.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
const packageName1 = 'WeLink-Themes-3.x';
2+
const packageName2 = 'WeLink-Themes-7.x';
3+
export default {
4+
paths() {
5+
return [
6+
{ params: { pkg: packageName1, version: '1.0.0' } },
7+
{ params: { pkg: packageName2, version: '1.0.0' } },
8+
{ params: { pkg: packageName1, version: '2.0.0' } },
9+
{ params: { pkg: packageName2, version: '2.0.0' } },
10+
{ params: { pkg: packageName1, version: '3.0.0' } },
11+
{ params: { pkg: packageName2, version: '3.0.0' } },
12+
];
13+
},
14+
};

‎package.json

+13-9
Original file line numberDiff line numberDiff line change
@@ -23,34 +23,38 @@
2323
"build:unpack": "pnpm build && electron-builder --dir",
2424
"build:win": "pnpm build && electron-builder --win",
2525
"build:mac": "pnpm build && electron-builder --mac",
26-
"build:linux": "pnpm build && electron-builder --linux"
26+
"build:linux": "pnpm build && electron-builder --linux",
27+
"docs:dev": "vitepress dev --port 8081",
28+
"docs:build": "vitepress build",
29+
"docs:preview": "vitepress preview --port 9091"
2730
},
2831
"dependencies": {
2932
"@electron-toolkit/preload": "^3.0.1",
3033
"@electron-toolkit/utils": "^3.0.0",
31-
"@opentiny/vue": "^3.17.0",
34+
"@opentiny/vue": "^3.17.2",
3235
"electron-store": "^8.2.0",
3336
"electron-updater": "^6.2.1",
3437
"express": "^4.19.2",
3538
"monaco-editor": "^0.50.0",
3639
"vue-i18n": "^9.13.1",
37-
"vue-router": "4.4.0"
40+
"vue-router": "4.4.2"
3841
},
3942
"devDependencies": {
4043
"@electron-toolkit/eslint-config": "^1.0.2",
4144
"@opentiny/unplugin-tiny-vue": "^0.0.2",
42-
"@rushstack/eslint-patch": "^1.10.3",
43-
"@vitejs/plugin-vue": "^5.0.5",
45+
"@rushstack/eslint-patch": "^1.10.4",
46+
"@vitejs/plugin-vue": "^5.1.2",
4447
"@vue/eslint-config-prettier": "^9.0.0",
45-
"electron": "^31.2.1",
48+
"electron": "^31.3.1",
4649
"electron-builder": "^24.13.3",
4750
"electron-vite": "^2.3.0",
48-
"eslint": "^9.7.0",
51+
"eslint": "^9.8.0",
4952
"eslint-plugin-vue": "^9.27.0",
5053
"less": "^4.2.0",
5154
"prettier": "^3.3.3",
52-
"vite": "^5.3.4",
53-
"vue": "^3.4.33"
55+
"vite": "^5.3.5",
56+
"vitepress": "^1.3.1",
57+
"vue": "^3.4.35"
5458
},
5559
"engines": {
5660
"node": "^18.0.0 || >=20.0.0"

‎pnpm-lock.yaml

+643-126
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎resources/link.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"Reference": "https://yequanrui.github.io/reference/"
3+
}

0 commit comments

Comments
 (0)
Please sign in to comment.