feat: 项目文档完善

This commit is contained in:
WANGFAN\wangf 2024-08-25 14:26:24 +08:00
parent 7ad5cce296
commit e2925cd441
8 changed files with 34 additions and 20 deletions

View File

@ -1,7 +1,7 @@
{ {
"name": "snow-admin", "name": "snow-admin",
"private": true, "private": true,
"version": "0.0.0", "version": "1.0.0",
"type": "module", "type": "module",
"scripts": { "scripts": {
"dev": "vite", "dev": "vite",

View File

@ -1 +1 @@
<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1720260253447" class="icon" viewBox="0 0 1049 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5236" xmlns:xlink="http://www.w3.org/1999/xlink" width="204.8828125" height="200"><path d="M524.979332 0C234.676191 0 0 234.676191 0 524.979332c0 232.068678 150.366597 428.501342 358.967656 498.035028 26.075132 5.215026 35.636014-11.299224 35.636014-25.205961 0-12.168395-0.869171-53.888607-0.869171-97.347161-146.020741 31.290159-176.441729-62.580318-176.441729-62.580318-23.467619-60.841976-58.234462-76.487055-58.234463-76.487055-47.804409-32.15933 3.476684-32.15933 3.476685-32.15933 53.019436 3.476684 80.83291 53.888607 80.83291 53.888607 46.935238 79.963739 122.553122 57.365291 152.97411 43.458554 4.345855-33.897672 18.252593-57.365291 33.028501-70.402857-116.468925-12.168395-239.022047-57.365291-239.022047-259.012982 0-57.365291 20.860106-104.300529 53.888607-140.805715-5.215026-13.037566-23.467619-66.926173 5.215027-139.067372 0 0 44.327725-13.906737 144.282399 53.888607 41.720212-11.299224 86.917108-17.383422 131.244833-17.383422s89.524621 6.084198 131.244833 17.383422C756.178839 203.386032 800.506564 217.29277 800.506564 217.29277c28.682646 72.1412 10.430053 126.029806 5.215026 139.067372 33.897672 36.505185 53.888607 83.440424 53.888607 140.805715 0 201.64769-122.553122 245.975415-239.891218 259.012982 19.121764 16.514251 35.636014 47.804409 35.636015 97.347161 0 70.402857-0.869171 126.898978-0.869172 144.282399 0 13.906737 9.560882 30.420988 35.636015 25.205961 208.601059-69.533686 358.967656-265.96635 358.967655-498.035028C1049.958663 234.676191 814.413301 0 524.979332 0z" fill="#191717" p-id="5237"></path><path d="M199.040177 753.571326c-0.869171 2.607513-5.215026 3.476684-8.691711 1.738342s-6.084198-5.215026-4.345855-7.82254c0.869171-2.607513 5.215026-3.476684 8.691711-1.738342s5.215026 5.215026 4.345855 7.82254z m-6.953369-4.345856M219.900283 777.038945c-2.607513 2.607513-7.82254 0.869171-10.430053-2.607514-3.476684-3.476684-4.345855-8.691711-1.738342-11.299224 2.607513-2.607513 6.953369-0.869171 10.430053 2.607514 3.476684 4.345855 4.345855 9.560882 1.738342 11.299224z m-5.215026-5.215027M240.760389 807.459932c-3.476684 2.607513-8.691711 0-11.299224-4.345855-3.476684-4.345855-3.476684-10.430053 0-12.168395 3.476684-2.607513 8.691711 0 11.299224 4.345855 3.476684 4.345855 3.476684 9.560882 0 12.168395z m0 0M269.443034 837.011749c-2.607513 3.476684-8.691711 2.607513-13.906737-1.738342-4.345855-4.345855-6.084198-10.430053-2.607513-13.037566 2.607513-3.476684 8.691711-2.607513 13.906737 1.738342 4.345855 3.476684 5.215026 9.560882 2.607513 13.037566z m0 0M308.555733 853.526c-0.869171 4.345855-6.953369 6.084198-13.037566 4.345855-6.084198-1.738342-9.560882-6.953369-8.691711-10.430053 0.869171-4.345855 6.953369-6.084198 13.037566-4.345855 6.084198 1.738342 9.560882 6.084198 8.691711 10.430053z m0 0M351.145116 857.002684c0 4.345855-5.215026 7.82254-11.299224 7.82254-6.084198 0-11.299224-3.476684-11.299224-7.82254s5.215026-7.82254 11.299224-7.82254c6.084198 0 11.299224 3.476684 11.299224 7.82254z m0 0M391.126986 850.049315c0.869171 4.345855-3.476684 8.691711-9.560882 9.560882-6.084198 0.869171-11.299224-1.738342-12.168395-6.084197-0.869171-4.345855 3.476684-8.691711 9.560881-9.560882 6.084198-0.869171 11.299224 1.738342 12.168396 6.084197z m0 0" fill="#191717" p-id="5238"></path></svg> <?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg t="1724566498979" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="20934" xmlns:xlink="http://www.w3.org/1999/xlink" width="200" height="200"><path d="M298.285714 772.571429q-4.571429 5.142857-11.428571-1.714286-7.428571-6.285714-2.285714-10.857143 4.571429-5.142857 11.428571 1.714286 6.857143 6.285714 2.285714 10.857143z m-24-34.857143q5.142857 6.857143 0 10.857143-4.571429 3.428571-9.714285-4t0-10.285715q5.142857-4 9.714285 3.428572z m-34.857143-34.285715q-2.857143 4-7.428571 1.142858-5.714286-2.857143-4-6.857143 1.714286-2.857143 7.428571-1.142857 5.714286 2.857143 4 6.857142z m17.714286 19.428572q-3.428571 4-9.142857-1.714286-5.142857-6.285714-1.142857-9.142857 3.428571-3.428571 9.142857 1.714286 5.142857 6.285714 1.142857 9.142857z m73.714286 64q-2.285714 6.857143-10.857143 3.428571-9.714286-2.285714-7.428571-8.571428t10.857142-4q9.142857 2.857143 7.428572 9.142857z m36 2.857143q0 6.285714-9.142857 6.285714-9.714286 1.142857-9.714286-6.285714 0-6.285714 9.142857-6.285715 9.714286-1.142857 9.714286 6.285715z m33.142857-5.714286q1.142857 5.714286-8 8t-10.285714-4.571429 8-8.571428q9.142857-1.142857 10.285714 5.142857z m550.857143-546.285714v548.571428q0 68-48.285714 116.285715T786.285714 950.857143h-128q-9.142857 0-14-0.571429t-11.142857-2.857143-9.142857-8.285714-2.857143-15.714286v-136.571428q0-55.428571-29.714286-81.142857 32.571429-3.428571 58.571429-10.285715t53.714286-22.285714 46.285714-38 30.285714-60T792 489.142857q0-69.142857-45.142857-117.714286 21.142857-52-4.571429-116.571428-16-5.142857-46.285714 6.285714t-52.571429 25.142857l-21.714285 13.714286q-53.142857-14.857143-109.714286-14.857143t-109.714286 14.857143q-9.142857-6.285714-24.285714-15.428571T330.285714 262.571429 281.142857 254.857143q-25.142857 64.571429-4 116.571428-45.142857 48.571429-45.142857 117.714286 0 48.571429 11.714286 85.714286t30 60 46 38.285714 53.714285 22.285714 58.571429 10.285715q-22.857143 20.571429-28 58.857143-12 5.714286-25.714286 8.571428t-32.571428 2.857143-37.428572-12.285714T276.571429 728q-10.857143-18.285714-27.714286-29.714286t-28.285714-13.714285l-11.428572-1.714286q-12 0-16.571428 2.571428t-2.857143 6.571429 5.142857 8 7.428571 6.857143l4 2.857143q12.571429 5.714286 24.857143 21.714285t18 29.142858l5.714286 13.142857q7.428571 21.714286 25.142857 35.142857t38.285714 17.142857 39.714286 4 31.714286-2l13.142857-2.285714q0 21.714286 0.285714 58.857143t0.285714 38.857142q0 12.571429-6.285714 19.142858t-12.571428 7.428571-18.857143 0.857143H237.714286q-68 0-116.285715-48.285714T73.142857 786.285714V237.714286q0-68 48.285714-116.285715T237.714286 73.142857h548.571428q68 0 116.285715 48.285714T950.857143 237.714286z" p-id="20935" fill="#1d2129"></path></svg>

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

View File

@ -52,7 +52,7 @@ export default {
["external-page"]: "external link page", ["external-page"]: "external link page",
["link-vue"]: "vue", ["link-vue"]: "vue",
["link-vite"]: "vite", ["link-vite"]: "vite",
["link-gitee"]: "gitee", ["link-github"]: "github",
["link-juejin"]: "juejin", ["link-juejin"]: "juejin",
["link-SnowAdmin-Docs"]: "Snow-Docs", ["link-SnowAdmin-Docs"]: "Snow-Docs",
["about-project"]: "about project", ["about-project"]: "about project",

View File

@ -53,7 +53,7 @@ export default {
["external-page"]: "外链页面", ["external-page"]: "外链页面",
["link-vue"]: "外链 vue官网", ["link-vue"]: "外链 vue官网",
["link-vite"]: "外链 vite官网", ["link-vite"]: "外链 vite官网",
["link-gitee"]: "外链 gitee", ["link-github"]: "外链 github",
["link-SnowAdmin-Docs"]: "外链 项目文档", ["link-SnowAdmin-Docs"]: "外链 项目文档",
["link-juejin"]: "外链 掘金", ["link-juejin"]: "外链 掘金",
["not-power"]: "没有权限", ["not-power"]: "没有权限",

View File

@ -17,7 +17,7 @@
</template> </template>
<script setup lang="ts"> <script setup lang="ts">
import Breadcrumb from "@/layout/components/Header/components/breadcrumb/index.vue"; import Breadcrumb from "@/layout/components/Header/components/Breadcrumb/index.vue";
import { storeToRefs } from "pinia"; import { storeToRefs } from "pinia";
import { useThemeConfig } from "@/store/modules/theme-config"; import { useThemeConfig } from "@/store/modules/theme-config";
const themeStore = useThemeConfig(); const themeStore = useThemeConfig();

View File

@ -83,7 +83,7 @@
<!-- 项目地址 --> <!-- 项目地址 -->
<a-doption @click="onProject"> <a-doption @click="onProject">
<template #default> <template #default>
<SvgIcon :name="'gitee'" :size="18" /> <SvgIcon :name="'github'" :size="18" />
<span class="margin-left-text">{{ $t(`language.project-address`) }}</span> <span class="margin-left-text">{{ $t(`language.project-address`) }}</span>
</template> </template>
</a-doption> </a-doption>
@ -104,7 +104,7 @@
</template> </template>
<script setup lang="ts"> <script setup lang="ts">
import Notice from "@/layout/components/Header/components/notice/index.vue"; import Notice from "@/layout/components/Header/components/Notice/index.vue";
import SystemSettings from "@/layout/components/Header/components/system-settings/index.vue"; import SystemSettings from "@/layout/components/Header/components/system-settings/index.vue";
import ThemeSettings from "@/layout/components/Header/components/theme-settings/index.vue"; import ThemeSettings from "@/layout/components/Header/components/theme-settings/index.vue";
import myImage from "@/assets/img/my-image.jpg"; import myImage from "@/assets/img/my-image.jpg";
@ -178,7 +178,7 @@ const onUpdate = () => {
// //
const onProject = () => { const onProject = () => {
window.open("https://gitee.com/wang_fan_w/SnowAdmin", "_blank"); window.open("https://github.com/WANG-Fan0912/SnowAdmin", "_blank");
}; };
// 退 // 退

View File

@ -807,16 +807,16 @@ export const dynamicRoutes: RouteRecordRaw[] = [
} }
}, },
{ {
path: "/external-links/external-page/link-gitee", path: "/external-links/external-page/link-github",
name: "link-gitee", name: "link-github",
component: () => import("@/views/external-links/external-page/external-page.vue"), component: () => import("@/views/external-links/external-page/external-page.vue"),
meta: { meta: {
title: "link-gitee", title: "link-github",
hide: false, hide: false,
disable: false, disable: false,
keepAlive: true, keepAlive: true,
affix: false, affix: false,
link: "https://gitee.com/wang_fan_w/SnowAdmin", // 链接 link: "https://github.com/WANG-Fan0912/SnowAdmin", // 链接
iframe: false, // 区分是否内链 true内链 false外链 iframe: false, // 区分是否内链 true内链 false外链
roles: ["admin"], roles: ["admin"],
icon: "icon-menu", icon: "icon-menu",

View File

@ -8,7 +8,15 @@
</div> </div>
</a-card> </a-card>
<a-card class="margin-top" title="项目信息"> <a-card class="margin-top" title="项目信息">
<a-descriptions :data="projectInfo" bordered :column="2" /> <a-descriptions :column="2" bordered>
<a-descriptions-item v-for="item of projectInfo" :key="item.label" :label="item.label">
<a-link :href="item.value" v-if="item.link">{{ item.label }}</a-link>
<!-- <a-tag :default-checked="true">Lark</a-tag> -->
<span v-else>{{ item.value }}</span>
</a-descriptions-item>
</a-descriptions>
<!-- <a-descriptions :data="projectInfo" bordered :column="2" /> -->
</a-card> </a-card>
<a-card class="margin-top" title="生产环境依赖"> <a-card class="margin-top" title="生产环境依赖">
<a-descriptions :data="dependencies" bordered :column="2" /> <a-descriptions :data="dependencies" bordered :column="2" />
@ -21,30 +29,36 @@
<script setup lang="ts"> <script setup lang="ts">
import packageJson from "../../../package.json"; import packageJson from "../../../package.json";
const projectInfo = [ const projectInfo: any = [
{ {
label: "版本号", label: "版本号",
link: false,
value: packageJson.version value: packageJson.version
}, },
{ {
label: "发布时间", label: "发布时间",
link: false,
value: "2024-06-18" value: "2024-06-18"
}, },
{ {
label: "Gitee", label: "GitHub",
value: "Gitee" link: true,
value: "https://github.com/WANG-Fan0912/SnowAdmin"
}, },
{ {
label: "Github", label: "Gitee",
value: "Github" link: true,
value: "https://gitee.com/wang_fan_w/SnowAdmin"
}, },
{ {
label: "文档地址", label: "文档地址",
value: "完善中" link: true,
value: "http://101.126.93.137:81/"
}, },
{ {
label: "预览地址", label: "预览地址",
value: "完善中" link: true,
value: "http://101.126.93.137/#/login"
} }
]; ];