create-young-proj 1.3.0 → 1.4.0

package/template-vitepress/.vitepress/config.mts

@@ -0,0 +1,159 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2023-11-08 15:46:58
+ * @LastEditTime: 2023-11-27 11:18:38
+ * @Description:
+ */
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: '前端知识库',
+  description: '多种实用工具，满足不同需求',
+  lang: 'zh-CN',
+  locales: {
+    root: {
+      label: '简体中文',
+      lang: 'zh',
+    }
+  },
+  base: '/wlb/fe/',
+  lastUpdated: true,
+  themeConfig: {
+    search: {
+      provider: 'local',
+      options: {
+        detailedView: true,
+        translations: {
+          button: {
+            buttonText: '搜索文档',
+            buttonAriaLabel: '搜索文档'
+          },
+          modal: {
+            noResultsText: '无法找到相关结果',
+            resetButtonTitle: '清除查询条件',
+            displayDetails: '显示详细信息',
+            footer: {
+              selectText: '选择',
+              navigateText: '切换',
+              closeText: '关闭'
+            }
+          }
+        },
+      }
+    },
+
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: '快速开始', link: '/newer' },
+      { text: '通用知识', link: '/common/dev-env', activeMatch: '^/common/' },
+    ],
+
+    docFooter: {
+      prev: '上一篇',
+      next: '下一篇',
+    },
+
+    outline: {
+      label: '本页目录',
+    },
+
+    lastUpdatedText: '最后更新时间',
+
+    sidebarMenuLabel: '菜单',
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2023-PRESENT BluesYoung-web',
+    },
+
+    sidebar: {
+      '/': [
+        {
+          text: '快速开始',
+          items: [
+            { text: '新人必读', link: '/newer' },
+            { text: '前端规范', link: '/standards' },
+            { text: '常见问题及解决方案', link: '/problems' },
+          ]
+        },
+        {
+          text: '通用知识',
+          base: '/common/',
+          items: [
+            { text: '1. 开发环境', link: 'dev-env' },
+            { text: '2. 开发必备知识点', link: 'basic-knowledge' },
+            { text: '3. 常用 vite 插件', link: 'vite-plugin' },
+          ]
+        },
+        {
+          text: '项目脚手架与模板介绍',
+          base: '/templates/',
+          items: [
+            { text: '1. 使用方法', link: 'how-to-use' },
+            { text: '2. template-nuxt-admin', link: 'nuxt-admin' },
+            { text: '3. template-nuxt-website', link: 'nuxt-website' },
+            { text: '4. template-uni-app', link: 'uni-app' },
+            { text: '5. template-vue-thin', link: 'vue-thin' },
+            { text: '6. template-vue-mobile', link: 'vue-mobile' },
+            { text: '7. template-admin-server', link: 'admin-server' },
+          ]
+        },
+        {
+          text: '项目部署',
+          items: [
+            { text: '使用 Docker 部署项目', link: '/common/project-deploy' },
+          ]
+        },
+      ],
+      '/libs/': [
+        {
+          text: '开源',
+          base: '/libs/public/',
+          items: [
+            { text: 'ui-vue3-element-plus', link: 'ui-vue3-element-plus' },
+            { text: 'http', link: 'http' },
+            { text: 'logger', link: 'logger' },
+            { text: 'rpc', link: 'rpc' },
+            { text: 'ui-vue3', link: 'ui-vue3' },
+          ],
+          collapsed: true
+        },
+        {
+          text: '内部',
+          base: '/libs/private/',
+          items: [
+            { text: '来游戏平台-通行证 JSSDK', link: 'lyx-js-sdk' },
+            { text: '悬浮球', link: 'young-float-ball' },
+          ]
+        }
+      ],
+    },
+
+    socialLinks: [
+      {
+        icon: {
+          svg: '<svg xmlns="http://www.w3.org/2000/svg" width="1.09em" height="1em" viewBox="0 0 256 236"><path fill="#E24329" d="m128.075 236.075l47.104-144.97H80.97l47.104 144.97Z"/><path fill="#FC6D26" d="M128.075 236.074L80.97 91.104H14.956l113.119 144.97Z"/><path fill="#FCA326" d="M14.956 91.104L.642 135.16a9.752 9.752 0 0 0 3.542 10.903l123.891 90.012l-113.12-144.97Z"/><path fill="#E24329" d="M14.956 91.105H80.97L52.601 3.79c-1.46-4.493-7.816-4.492-9.275 0l-28.37 87.315Z"/><path fill="#FC6D26" d="m128.075 236.074l47.104-144.97h66.015l-113.12 144.97Z"/><path fill="#FCA326" d="m241.194 91.104l14.314 44.056a9.752 9.752 0 0 1-3.543 10.903l-123.89 90.012l113.119-144.97Z"/><path fill="#E24329" d="M241.194 91.105h-66.015l28.37-87.315c1.46-4.493 7.816-4.492 9.275 0l28.37 87.315Z"/></svg>'
+        },
+        link: 'gitlab仓库的完整地址',
+      },
+    ],
+
+    editLink: {
+      pattern: 'https://gitlab地址/-/ide/project/此处换成仓库的具体路径/edit/master/-/:path',
+      text: '在 gitlab 上编辑此页'
+    }
+  },
+  head: [
+    ['link', { rel: 'icon', href: 'https://api.iconify.design/noto:rocket.svg?color=%2312b2e7' }]
+  ],
+  markdown: {
+    container: {
+      tipLabel: '提示',
+      warningLabel: '注意',
+      dangerLabel: '警告',
+      detailsLabel: '详细信息',
+      infoLabel: '信息',
+    }
+  },
+})

package/template-vitepress/.vitepress/theme/index.ts

@@ -0,0 +1,26 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2023-11-08 16:14:48
+ * @LastEditTime: 2023-11-08 16:39:59
+ * @Description: 
+ */
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+import HomePage from '../components/HomePage.vue'
+import 'uno.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+      'home-features-after': () => h(HomePage),
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

package/template-vitepress/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

package/template-vitepress/Dockerfile

@@ -0,0 +1,41 @@
+# 拉取基础镜像
+FROM intranet-harbor.laiyouxi.com/base/alpine/node:20.9.0 as builder
+# 添加部分元数据，暂无意义
+LABEL vendor="Lyx-yunwei" \
+      com.example.release-date="2022-11-10" \
+      com.example.version.is-production="false"
+
+# 维护者
+MAINTAINER BluesYoung "bluesyoung_web@163.com"
+# 配置环境变量
+ENV WORK_DIR=/app
+
+# 工作目录
+WORKDIR /app
+
+# 没有压缩包，首选 COPY，如果需要自动解包或下载，则使用 ADD
+
+# 对比依赖是否变更
+COPY package.json yarn.lock /app/
+
+# 设置npm仓库 + 下载依赖，上面的文件如果没有变化则跳过下载，直接使用缓存
+RUN npm config set registry https://registry.npmmirror.com && \
+    yarn config set registry https://registry.npmmirror.com && \
+    yarn
+
+# 加入代码
+COPY . /app
+# 打包
+RUN yarn build
+
+# 打包完成，构建最终的极简镜像
+FROM intranet-harbor.laiyouxi.com/base/alpine/node:20.9.0
+
+WORKDIR /app
+# 复制源码
+COPY boot.mjs /app/
+COPY config /app/config
+# 复制编译后的代码
+COPY --from=builder /app/.output /app/.output
+
+ENTRYPOINT ["node", "boot.mjs"]

package/template-vitepress/README.md

@@ -0,0 +1,102 @@
+# template-vitepress
+
+[![](https://img.shields.io/badge/Author-BluesYoung--web-blue)](https://gitee.com/BluesYoung-web)
+
+## 本地运行
+
+::: code-group
+```bash [yarn]
+# 装依赖
+yarn
+# 运行
+yarn dev
+```
+```bash [pnpm]
+# 装依赖
+pnpm i
+# 运行
+pnpm dev
+```
+```bash [bun]
+# 装依赖
+bun i
+# 运行
+bun dev
+```
+```bash [npm]
+# 装依赖
+npm i
+# 运行
+npm run dev
+```
+:::
+
+## 到手之后需要自行调整的内容
+
+### `.vitepress/config.mts`
+
+<TodoItem>seo 相关<code ml-1>title, description</code></TodoItem>
+
+:::danger
+<TodoItem>部署相关<code ml-1>base</code></TodoItem>
+
+- 根路径部署就删掉，否则为部署的路径，**必须以 `/` 结尾**
+
+- [官方文档](https://vitepress.dev/reference/site-config#base)
+:::
+
+<TodoItem><a href="https://vitepress.dev/reference/default-theme-nav" target="_blank">顶部导航</a> <code ml-1>themeConfig -> nav</code></TodoItem>
+
+<TodoItem><a href="https://vitepress.dev/reference/default-theme-sidebar" target="_blank">侧边栏导航</a> <code ml-1>themeConfig -> sidebar</code></TodoItem>
+
+<TodoItem>替换仓库地址 <code ml-1>themeConfig -> socialLinks -> link</code></TodoItem>
+
+<TodoItem>替换仓库地址 <code ml-1>themeConfig -> editLink -> pattern</code></TodoItem>
+
+### `index.md`
+
+<TodoItem>标题及描述 <code ml-1>hero -> [name, text, tagline]</code></TodoItem>
+
+<TodoItem>快捷导航 <code ml-1>hero -> actions</code></TodoItem>
+
+<TodoItem>特性介绍 <code ml-1>features</code></TodoItem>
+
+### 首页贡献者
+
+`.vitepress/components/HomePage.vue -> teamMembers` 按需修改
+
+:::info
+如果不需要展示，将 `.vitepress/theme/index.ts -> 'home-features-after'` 这一行注释即可
+:::
+
+## 文档书写
+
+### 简介
+
+标题：`使用 # 符号表示标题，数量代表标题级别。例如：# 一级标题、## 二级标题`
+
+段落和换行：`段落之间使用空行分隔，要插入换行符，可以在行末添加两个空格`
+
+强调：`使用 * 或 _ 包围文本来斜体显示，使用两个 * 或 _ 包围文本来加粗显示。例如：*斜体文本*、**加粗文本**`
+
+列表：`使用 *、+ 或 - 开头创建无序列表，使用数字后跟句点创建有序列表。嵌套列表时缩进四个空格或一个制表符`
+
+链接：`使用 [显示文本](链接地址) 的格式创建链接。例如：[OpenAI](https://openai.com)`
+
+图片：`使用 ![替代文本](图片链接地址) 的格式插入图片。例如：![Logo](https://example.com/logo.png)`
+
+引用块：`使用 > 表示引用块。可以嵌套使用多个 > 表示多层引用`
+
+代码块：`使用三个反引号 ```` 或四个空格缩进来创建代码块。可以指定语言以进行语法高亮`
+
+水平线：`使用三个或更多连续的 -、* 或 _ 创建水平线分隔线`
+
+转义字符：`在特殊字符前添加反斜杠 \ 可以转义字符的原始含义`
+
+### 外部教程
+
+[vitepress 扩展语法](https://vitepress.dev/guide/markdown)
+
+[基础语法](https://www.markdownguide.org/basic-syntax/)
+
+[中文技术文档的写作规范——阮一峰](https://github.com/ruanyf/document-style-guide)

package/template-vitepress/_gitignore

@@ -0,0 +1,6 @@
+node_modules
+*.log
+cache
+dist
+.output
+.nitro

package/template-vitepress/_npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+strict-peer-dependencies=false

package/template-vitepress/_nvmrc

@@ -0,0 +1 @@
+20.9.0

package/template-vitepress/boot.mjs

@@ -0,0 +1,17 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-09-16 11:48:05
+ * @LastEditTime: 2023-11-09 11:59:07
+ * @Description:
+ */
+(async () => {
+  const env = process.env.DEPLOY_ENV || 'dev';
+  const listenPort = process.env.LISTEN_PORT || 3333;
+  console.log('当前环境：', env);
+  console.log('服务监听端口：', listenPort);
+
+  process.env.NITRO_PORT = listenPort;
+
+  await import('./.output/server/index.mjs');
+})();
+

package/template-vitepress/index.md

@@ -0,0 +1,53 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: 前端知识库
+  text: 知识共建，共创未来
+  tagline: 多种实用工具，满足不同需求
+  image:
+    src: https://api.iconify.design/noto:rocket.svg?color=%2312b2e7&width=320
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /newer
+    - theme: alt
+      text: 前端规范
+      link: /standards
+    - theme: alt
+      text: 常见问题及解决方案
+      link: /problems
+
+features:
+  - title: '@bluesyoung/ui-vue3-element-plus'
+    icon: <span class="i-ep-element-plus text-[#409eff]"></span>
+    details: 基于 element-plus 二次封装的常用组件库
+    link: /libs/public/ui-vue3-element-plus
+
+  - title: '@bluesyoung/http'
+    icon: <span class="i-logos-lighttpd"></span>
+    details: 基于 axios 封装的 http 请求库, 拥有完善的 TS 类型提示, 支持 web/微信小程序
+    link: /libs/public/http
+
+  - title: '@bluesyoung/utils'
+    icon: <span class="i-tabler-tools text-[#409eff]"></span>
+    details: 常用工具函数
+    link: https://gitee.com/-/ide/project/BluesYoung-web/young/edit/master/-/packages/utils/dist/index.d.ts
+
+  - title: '@bluesyoung/logger'
+    icon: <span class="i-vscode-icons-file-type-log"></span>
+    details: 基于 consola 封装的日志工具, 默认格式化为容器部署要求的格式, 并保留了扩充能力
+    link: /libs/public/logger
+  
+  - title: '@bluesyoung/rpc'
+    icon: <span class="i-simple-icons-trpc text-[#409eff]"></span>
+    details: 页面与其嵌套的 iframe 或由其打开的子页面之间进行通信
+    link: /libs/public/rpc
+
+  - title: '@bluesyoung/ui-vue3'
+    icon: <span class="i-logos-vue"></span>
+    details: 基于 vue3 + @vueuse/core 封装的组件，无额外的依赖
+    link: /libs/public/ui-vue3
+---
+

package/template-vitepress/nitro.config.ts

@@ -0,0 +1,19 @@
+/*
+ * @Author: zhangyang
+ * @Date: 2022-12-28 11:59:56
+ * @LastEditTime: 2023-11-14 09:18:38
+ * @Description:
+ */
+export default defineNitroConfig({
+  /**
+   * 托管前端静态资源
+   */
+  serveStatic: 'node',
+  publicAssets: [
+    {
+      dir: '.vitepress/dist',
+    },
+  ],
+  preset: 'bun'
+});
+

package/template-vitepress/package.json

@@ -0,0 +1,26 @@
+{
+  "scripts": {
+    "dev": "vitepress dev",
+    "docs:dev": "vitepress dev",
+    "docs:build": "vitepress build",
+    "docs:preview": "vitepress preview",
+    "build": "vitepress build && nitropack build",
+    "postinstall": "nitropack prepare"
+  },
+  "devDependencies": {
+    "@iconify/json": "^2.2.139",
+    "@types/md5": "^2.3.5",
+    "@types/node": "20",
+    "nitropack": "^2.7.2",
+    "pathe": "^1.1.1",
+    "unocss": "^0.57.2",
+    "unplugin-vue-components": "^0.25.2",
+    "vitepress": "^1.0.0-rc.25",
+    "vue": "^3.3.8"
+  },
+  "dependencies": {
+    "c12": "^1.5.1",
+    "md5": "^2.3.0"
+  },
+  "version": "1.0.0"
+}