chore(docs): add vitePress project docs frame

2025-12-06 17:08:26 +08:00 · 2024-06-15 18:18:22 +08:00 · 2024-06-15 18:18:22 +08:00 · 6f71ad58dd
commit 6f71ad58dd
parent 33b68e232d
13 changed files with 408 additions and 0 deletions
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@ -0,0 +1,107 @@
+import {defineConfig} from 'vitepress';
+
+export default defineConfig({
+    locales: {
+        root: {
+            label: '简体中文',
+            lang: 'zh',
+            dir: 'src/zh',
+            title: 'MinIO-Plus',
+            description: '成为 MinIO 最好的搭档'
+        },
+        en: {
+            label: 'English',
+            lang: 'en',
+            dir: 'src/en',
+            title: 'MinIO-Plus',
+            description: '成为 MinIO 最好的搭档',
+            themeConfig: {
+                footer: {
+                    message: '根据 MIT 许可证发布',
+                    copyright: 'Copyright © 2024 lxp'
+                },
+                nav: [
+                    {text: '指引', link: '/en/guide/intro', activeMatch: '/en/guide/'},
+                    {text: '常见问题', link: '/en/faq/', activeMatch: '/en/faq/'},
+                    {text: '捐赠', link: '/en/other/donate'},
+                ],
+                sidebar: {
+                    '/en/guide/': [
+                        {
+                            text: 'Getting Started',
+                            items: [
+                                {
+                                    text: 'Introduction',
+                                    link: '/en/guide/intro'
+                                },
+                                {
+                                    text: 'Quick Start',
+                                    link: '/en/guide/quick-start'
+                                }
+                            ]
+                        },
+                    ],
+                }
+            }
+        }
+    },
+    head: [
+        ['meta', {name: 'author', content: 'lxp'}],
+        [
+            'meta',
+            {
+                name: 'keywords',
+                content: 'minio, minio-plus minio tool'
+            }
+        ],
+        ['link', {rel: 'icon', type: 'image/svg+xml', href: '/logo.svg'}],
+        [
+            'meta',
+            {
+                name: 'viewport',
+                content: 'width=device-width,initial-scale=1,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no'
+            }
+        ],
+        ['link', {rel: 'icon', href: '/favicon.ico'}]
+    ],
+    assetsDir: 'public',
+    srcDir: 'src',
+    themeConfig: {
+        logo: '/logo.svg',
+        socialLinks: [
+            {icon: 'github', link: 'https://github.com/lxp135/minio-plus'},
+
+        ],
+        algolia: {
+            appId: 'sddsf',
+            apiKey: 'sdfsdf',
+            indexName: 'BaldHead'
+        },
+        footer: {
+            message: 'Publish under the MIT license',
+            copyright: 'Copyright © 2024 lxp'
+        },
+        nav: [
+            {text: '指引', link: '/guide/intro', activeMatch: '/zh/guide/'},
+            {text: '常见问题', link: '/faq/', activeMatch: '/zh/faq/'},
+            {text: '捐赠', link: '/other/donate'},
+        ],
+        sidebar: {
+            '/guide/': [
+                {
+                    text: '开始',
+                    items: [
+                        {
+                            text: '简介',
+                            link: '/guide/intro'
+                        },
+                        {
+                            text: '快速上手',
+                            link: '/guide/quick-start'
+                        }
+                    ]
+                },
+            ],
+        }
+    }
+});
--- a/docs/.vitepress/icon.ts
+++ b/docs/.vitepress/icon.ts
@ -0,0 +1,32 @@
+export const qqSvg = `
+<svg height="2500" viewBox="-1.94 0 124.879 145.085" width="2101" xmlns="http://www.w3.org/2000/svg">
+	<path
+		d="m60.503 142.237c-12.533 0-24.038-4.195-31.445-10.46-3.762 1.124-8.574 2.932-11.61 5.175-2.6 1.918-2.275 3.874-1.807 4.663 2.056 3.47 35.273 2.216 44.862 1.136zm0 0c12.535 0 24.039-4.195 31.447-10.46 3.76 1.124 8.573 2.932 11.61 5.175 2.598 1.918 2.274 3.874 1.805 4.663-2.056 3.47-35.272 2.216-44.862 1.136zm0 0"
+		fill="#faab07"
+	/>
+	<path
+		d="m60.576 67.119c20.698-.14 37.286-4.147 42.907-5.683 1.34-.367 2.056-1.024 2.056-1.024.005-.189.085-3.37.085-5.01 0-27.634-13.044-55.401-45.124-55.402-32.08.001-45.125 27.769-45.125 55.401 0 1.642.08 4.822.086 5.01 0 0 .583.615 1.65.913 5.19 1.444 22.09 5.65 43.312 5.795zm56.245 23.02c-1.283-4.129-3.034-8.944-4.808-13.568 0 0-1.02-.126-1.537.023-15.913 4.623-35.202 7.57-49.9 7.392h-.153c-14.616.175-33.774-2.737-49.634-7.315-.606-.175-1.802-.1-1.802-.1-1.774 4.624-3.525 9.44-4.808 13.568-6.119 19.69-4.136 27.838-2.627 28.02 3.239.392 12.606-14.821 12.606-14.821 0 15.459 13.957 39.195 45.918 39.413h.848c31.96-.218 45.917-23.954 45.917-39.413 0 0 9.368 15.213 12.607 14.822 1.508-.183 3.491-8.332-2.627-28.021"
+	/>
+	<path
+		d="m49.085 40.824c-4.352.197-8.07-4.76-8.304-11.063-.236-6.305 3.098-11.576 7.45-11.773 4.347-.195 8.064 4.76 8.3 11.065.238 6.306-3.097 11.577-7.446 11.771m31.133-11.063c-.233 6.302-3.951 11.26-8.303 11.063-4.35-.195-7.684-5.465-7.446-11.77.236-6.305 3.952-11.26 8.3-11.066 4.352.197 7.686 5.468 7.449 11.773"
+		fill="#fff"
+	/>
+	<path
+		d="m87.952 49.725c-1.162-2.575-12.875-5.445-27.374-5.445h-.156c-14.5 0-26.212 2.87-27.375 5.446a.863.863 0 0 0 -.085.367c0 .186.063.352.16.496.98 1.427 13.985 8.487 27.3 8.487h.156c13.314 0 26.319-7.058 27.299-8.487a.873.873 0 0 0 .16-.498.856.856 0 0 0 -.085-.365"
+		fill="#faab07"
+	/>
+	<path
+		d="m54.434 29.854c.199 2.49-1.167 4.702-3.046 4.943-1.883.242-3.568-1.58-3.768-4.07-.197-2.492 1.167-4.704 3.043-4.944 1.886-.244 3.574 1.58 3.771 4.07m11.956.833c.385-.689 3.004-4.312 8.427-2.993 1.425.347 2.084.857 2.223 1.057.205.296.262.718.053 1.286-.412 1.126-1.263 1.095-1.734.875-.305-.142-4.082-2.66-7.562 1.097-.24.257-.668.346-1.073.04-.407-.308-.574-.93-.334-1.362"
+	/>
+	<path
+		d="m60.576 83.08h-.153c-9.996.12-22.116-1.204-33.854-3.518-1.004 5.818-1.61 13.132-1.09 21.853 1.316 22.043 14.407 35.9 34.614 36.1h.82c20.208-.2 33.298-14.057 34.616-36.1.52-8.723-.087-16.035-1.092-21.854-11.739 2.315-23.862 3.64-33.86 3.518"
+		fill="#fff"
+	/>
+	<g fill="#eb1923">
+		<path d="m32.102 81.235v21.693s9.937 2.004 19.893.616v-20.009c-6.307-.357-13.109-1.152-19.893-2.3" />
+		<path
+			d="m105.539 60.412s-19.33 6.102-44.963 6.275h-.153c-25.591-.172-44.896-6.255-44.962-6.275l-6.474 16.158c16.193 4.882 36.261 8.028 51.436 7.845h.153c15.175.183 35.242-2.963 51.437-7.845zm0 0"
+		/>
+	</g>
+</svg>
+`;
--- a/docs/.vitepress/theme/index.ts
+++ b/docs/.vitepress/theme/index.ts
@ -0,0 +1,4 @@
+import Theme from 'vitepress/theme';
+import './style.css';
+
+export default Theme;
--- a/docs/.vitepress/theme/style.css
+++ b/docs/.vitepress/theme/style.css
@ -0,0 +1,106 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ * -------------------------------------------------------------------------- */
+
+:root {
+    --vp-c-brand: #646cff;
+    --vp-c-brand-light: #747bff;
+    --vp-c-brand-lighter: #9499ff;
+    --vp-c-brand-lightest: #bcc0ff;
+    --vp-c-brand-dark: #535bf2;
+    --vp-c-brand-darker: #454ce1;
+    --vp-c-brand-dimm: rgba(100, 108, 255, 0.08);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+    --vp-button-brand-border: var(--vp-c-brand-light);
+    --vp-button-brand-text: var(--vp-c-white);
+    --vp-button-brand-bg: var(--vp-c-brand);
+    --vp-button-brand-hover-border: var(--vp-c-brand-light);
+    --vp-button-brand-hover-text: var(--vp-c-white);
+    --vp-button-brand-hover-bg: var(--vp-c-brand-light);
+    --vp-button-brand-active-border: var(--vp-c-brand-light);
+    --vp-button-brand-active-text: var(--vp-c-white);
+    --vp-button-brand-active-bg: var(--vp-button-brand-bg);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+    --vp-home-hero-name-color: transparent;
+    --vp-home-hero-name-background: -webkit-linear-gradient(
+            120deg,
+            var(--vp-c-brand-lightest) 30%,
+            var(--vp-c-brand-darker)
+    );
+
+    --vp-home-hero-image-background-image: linear-gradient(-45deg, var(--vp-c-brand-lightest) 30%, var(--vp-c-brand) 50%);
+    --vp-home-hero-image-filter: blur(40px);
+}
+
+@media (min-width: 640px) {
+    :root {
+        --vp-home-hero-image-filter: blur(56px);
+    }
+}
+
+@media (min-width: 960px) {
+    :root {
+        --vp-home-hero-image-filter: blur(72px);
+    }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+    --vp-custom-block-tip-border: var(--vp-c-brand);
+    --vp-custom-block-tip-text: var(--vp-c-brand-darker);
+    --vp-custom-block-tip-bg: var(--vp-c-brand-dimm);
+}
+
+.dark {
+    --vp-custom-block-tip-border: var(--vp-c-brand);
+    --vp-custom-block-tip-text: var(--vp-c-brand-lightest);
+    --vp-custom-block-tip-bg: var(--vp-c-brand-dimm);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+    --docsearch-primary-color: var(--vp-c-brand) !important;
+}
+
+/**
+ * Version Badge
+ * -------------------------------------------------------------------------- */
+
+.vt-badge {
+    display: inline-block;
+    border-radius: 6px;
+    font-size: 0.65em;
+    line-height: 1;
+    font-weight: 600;
+    letter-spacing: 2px;
+    padding: 0.35em 0.4em 0.3em;
+    position: relative;
+    top: -0.65em;
+    margin-left: 0.5em;
+    color: #ffffff;
+    transition: color 0.5s;
+    background-color: var(--vp-c-brand);
+}
--- a/docs/package.json
+++ b/docs/package.json
@ -0,0 +1,24 @@
+{
+  "name": "MinIO-Plus-docs",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "The documentation of MinIO-Plus",
+  "author": {
+    "name": "BaldHead",
+    "email": "tianxiang.deng@foxmail.com",
+    "url": "https://github.com/bald-head"
+  },
+  "scripts": {
+    "dev": "vitepress dev --port 1026",
+    "docs:build": "vitepress build",
+    "preview": "vite preview",
+    "release": "soy release",
+    "serve": "vitepress serve"
+  },
+  "devDependencies": {
+    "@soybeanjs/cli": "1.0.13",
+    "@types/node": "20.12.7",
+    "typescript": "5.4.5",
+    "vitepress": "1.2.3"
+  }
+}
--- a/docs/src/en/guide/intro.md
+++ b/docs/src/en/guide/intro.md
@ -0,0 +1,28 @@
+<h1 align="center">MinIO Plus</h1>
+<h3 align="center">我们的愿景是成为 MinIO 最好的搭档</h3>
+
+<p align="center">
+  <a target="_blank" href="https://central.sonatype.com/search?q=me.liuxp.minio-plus-all-spring-boot-starter">
+      <img src="https://img.shields.io/maven-central/v/me.liuxp/minio-plus-core.svg?label=Maven%20Central" />
+  </a>
+  <a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0">
+      <img src="https://img.shields.io/badge/license-Apache%202-green.svg" alt="开源协议" />
+  </a>
+  <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
+      <img src="https://img.shields.io/badge/JDK-8+-red.svg" alt='JDK版本'/>
+  </a>
+  <a href='https://gitee.com/lxp135/minio-plus'>
+      <img src='https://gitee.com/lxp135/minio-plus/badge/star.svg?theme=dark' alt='star' />
+  </a>
+  <a href="https://gitee.com/lxp135/minio-plus">
+    <img src="https://gitee.com/lxp135/minio-plus/badge/fork.svg?theme=dark" alt="Gitee fork">
+  </a>
+  <br />
+</p>
+
+---
+
+# 0 简介 | Intro
+
+[MinIO-Plus](https://gitee.com/lxp135/minio-plus/) 是一个 [MinIO](https://github.com/minio/minio) 的二次封装与增强工具，在
+MinIO 的基础上只做增强，不侵入 MinIO 代码，只为简化开发、提高效率而生。成为 MinIO 在项目中落地的润滑剂。
--- a/docs/src/en/guide/quick-start.md
+++ b/docs/src/en/guide/quick-start.md
@ -0,0 +1,2 @@
+# 快速开始
+
--- a/docs/src/guide/intro.md
+++ b/docs/src/guide/intro.md
@ -0,0 +1,28 @@
+<h1 align="center">MinIO Plus</h1>
+<h3 align="center">我们的愿景是成为 MinIO 最好的搭档</h3>
+
+<p align="center">
+  <a target="_blank" href="https://central.sonatype.com/search?q=me.liuxp.minio-plus-all-spring-boot-starter">
+      <img src="https://img.shields.io/maven-central/v/me.liuxp/minio-plus-core.svg?label=Maven%20Central" />
+  </a>
+  <a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0">
+      <img src="https://img.shields.io/badge/license-Apache%202-green.svg" alt="开源协议" />
+  </a>
+  <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
+      <img src="https://img.shields.io/badge/JDK-8+-red.svg" alt='JDK版本'/>
+  </a>
+  <a href='https://gitee.com/lxp135/minio-plus'>
+      <img src='https://gitee.com/lxp135/minio-plus/badge/star.svg?theme=dark' alt='star' />
+  </a>
+  <a href="https://gitee.com/lxp135/minio-plus">
+    <img src="https://gitee.com/lxp135/minio-plus/badge/fork.svg?theme=dark" alt="Gitee fork">
+  </a>
+  <br />
+</p>
+
+---
+
+# 0 简介 | Intro
+
+[MinIO-Plus](https://gitee.com/lxp135/minio-plus/) 是一个 [MinIO](https://github.com/minio/minio) 的二次封装与增强工具，在
+MinIO 的基础上只做增强，不侵入 MinIO 代码，只为简化开发、提高效率而生。成为 MinIO 在项目中落地的润滑剂。
--- a/docs/src/guide/quick-start.md
+++ b/docs/src/guide/quick-start.md
@ -0,0 +1,2 @@
+# 快速开始
+
--- a/docs/src/index.md
+++ b/docs/src/index.md
@ -0,0 +1,44 @@
+---
+layout: home
+
+title: MinIO-Plus
+titleTemplate: MinIO 的二次封装与增强工具
+
+hero:
+  name: MinIO-Plus
+  text: 二次封装与增强工具
+  tagline: 成为 MinIO 最好的搭档
+  image:
+    src: /logo.svg
+    alt: MinIO-Plus
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /zh/guide/quick-start
+    - theme: alt
+      text: 介绍
+      link: /zh/guide/intro
+    - theme: alt
+      text: 在github上查看
+      link: https://github.com/lxp135/minio-plus
+
+features:
+  - icon: 🆕
+    title: Latest popular technology stack
+    details: Vue3, Vite5, TypeScript, Pinia, UnoCSS.
+  - icon: 🦋
+    title: Clean Structure
+    details: Use pnpm monorepo, clean and elegant structure, easy to maintain. Very high code specification.
+  - icon: 🛠️
+    title: TypeScript
+    details: Strictly typed, easy to maintain.
+  - icon: 🔩
+    title: Theme
+    details: Built-in rich theme configuration, easy to incorporate UnoCSS.
+  - icon: 🔗
+    title: File routing System
+    details: Automatic, intelligent file routing system.
+  - icon: 🔑
+    title: Auth Router
+    details: Support front-end static routing and back-end dynamic routing.
+---
--- a/docs/src/public/favicon.svg
+++ b/docs/src/public/favicon.svg
@ -0,0 +1,4 @@
+<svg viewBox="0 0 160 160" xmlns="http://www.w3.org/2000/svg"  fill="none" stroke-width="3" stroke-linecap="round" stroke-linejoin="round">
+<path d="m49.58378,29.95523c5.11126,-0.15399 10.21323,0.00046 15.30594,0.46382c-9.9535,17.04618 -19.84809,34.12992 -29.68424,51.2517c1.237,2.00972 2.47353,4.0199 3.71053,6.02961c27.05579,0.15445 54.11205,0.30937 81.16784,0.46382c-9.79858,16.89126 -19.53872,33.82055 -29.22042,50.78788c-12.52026,0.54127 -25.04329,0.61827 -37.56912,0.23191c-4.94753,-8.50314 -9.89459,-17.00675 -14.84212,-25.50989c5.10198,-0.30937 10.20396,-0.30937 15.30594,0c2.37752,3.90441 4.6966,7.84684 6.95724,11.82731c7.41642,0.54081 14.83748,0.61827 22.26318,0.23191c4.79261,-8.19424 9.58569,-16.38802 14.3783,-24.58226c-22.10873,-0.15445 -44.217,-0.30937 -66.32572,-0.46382c-3.76897,-6.3784 -7.4795,-12.79437 -11.13159,-19.24837c10.0175,-17.09812 19.9121,-34.25932 29.68424,-51.4836z" fill="#129dcb"/>
+	<path d="m71.84696,29.95523c12.36952,-0.07746 24.73764,0 37.1053,0.23191c5.00597,8.54257 9.9535,17.12317 14.84212,25.7418c-5.10198,0.61827 -10.20396,0.61827 -15.30594,0c-2.31908,-4.0199 -4.63816,-8.03933 -6.95724,-12.05922c-7.42106,-0.61827 -14.84212,-0.61827 -22.26318,0c-4.63816,8.03933 -9.27633,16.07912 -13.91449,24.11845c21.95242,0.38636 43.90624,0.61827 65.86191,0.69572c3.76897,6.3784 7.4795,12.79437 11.13159,19.24837c-9.80229,17.14404 -19.69688,34.22778 -29.68424,51.2517c-5.10198,0.30937 -10.20396,0.30937 -15.30594,0c9.72159,-16.73681 19.38427,-33.51165 28.98852,-50.32406c0.30937,-0.61827 0.30937,-1.237 0,-1.85527c-0.9434,-1.48699 -1.79358,-3.03336 -2.55099,-4.63816c-27.21071,-0.30937 -54.42095,-0.61827 -81.63166,-0.92763c9.78281,-17.24979 19.67787,-34.41099 29.68424,-51.4836z" fill="#129dcb"/>
+</svg>
--- a/docs/src/public/logo.svg
+++ b/docs/src/public/logo.svg
@ -0,0 +1,4 @@
+<svg viewBox="0 0 160 160" xmlns="http://www.w3.org/2000/svg"  fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round">
+  <path d="m49.58378,29.95523c5.11126,-0.15399 10.21323,0.00046 15.30594,0.46382c-9.9535,17.04618 -19.84809,34.12992 -29.68424,51.2517c1.237,2.00972 2.47353,4.0199 3.71053,6.02961c27.05579,0.15445 54.11205,0.30937 81.16784,0.46382c-9.79858,16.89126 -19.53872,33.82055 -29.22042,50.78788c-12.52026,0.54127 -25.04329,0.61827 -37.56912,0.23191c-4.94753,-8.50314 -9.89459,-17.00675 -14.84212,-25.50989c5.10198,-0.30937 10.20396,-0.30937 15.30594,0c2.37752,3.90441 4.6966,7.84684 6.95724,11.82731c7.41642,0.54081 14.83748,0.61827 22.26318,0.23191c4.79261,-8.19424 9.58569,-16.38802 14.3783,-24.58226c-22.10873,-0.15445 -44.217,-0.30937 -66.32572,-0.46382c-3.76897,-6.3784 -7.4795,-12.79437 -11.13159,-19.24837c10.0175,-17.09812 19.9121,-34.25932 29.68424,-51.4836z" fill="none"/>
+  <path d="m71.84696,29.95523c12.36952,-0.07746 24.73764,0 37.1053,0.23191c5.00597,8.54257 9.9535,17.12317 14.84212,25.7418c-5.10198,0.61827 -10.20396,0.61827 -15.30594,0c-2.31908,-4.0199 -4.63816,-8.03933 -6.95724,-12.05922c-7.42106,-0.61827 -14.84212,-0.61827 -22.26318,0c-4.63816,8.03933 -9.27633,16.07912 -13.91449,24.11845c21.95242,0.38636 43.90624,0.61827 65.86191,0.69572c3.76897,6.3784 7.4795,12.79437 11.13159,19.24837c-9.80229,17.14404 -19.69688,34.22778 -29.68424,51.2517c-5.10198,0.30937 -10.20396,0.30937 -15.30594,0c9.72159,-16.73681 19.38427,-33.51165 28.98852,-50.32406c0.30937,-0.61827 0.30937,-1.237 0,-1.85527c-0.9434,-1.48699 -1.79358,-3.03336 -2.55099,-4.63816c-27.21071,-0.30937 -54.42095,-0.61827 -81.63166,-0.92763c9.78281,-17.24979 19.67787,-34.41099 29.68424,-51.4836z" fill="none"/>
+</svg>
--- a/docs/tsconfig.json
+++ b/docs/tsconfig.json
@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "lib": ["DOM", "ESNext"],
+    "baseUrl": ".",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "types": ["vite/client", "node"],
+    "strict": true,
+    "strictNullChecks": true,
+    "noUnusedLocals": true,
+    "outDir": "dist",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true
+  },
+  "include": [".vitepress/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}