chore: init

.github/workflows/deploy.yml

@@ -0,0 +1,60 @@
+name: Deploy EasyTemplate Docs to Pages
+
+on:
+  # 在针对 `main` 分支的推送上运行。
+  push:
+    branches: [main]
+
+  # 允许你从 Actions 选项卡手动运行此工作流程
+  workflow_dispatch:
+
+# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
+# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # 构建工作
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
+      - uses: pnpm/action-setup@v3 # 使用 pnpm
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: pnpm docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  # 部署工作
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,3 @@
+.vitepress/dist
+.vitepress/cache
+node_modules

.vitepress/config.ts

@@ -0,0 +1,199 @@
+import { defineConfig, DefaultTheme } from 'vitepress'
+
+const Guides: DefaultTheme.NavItemWithLink[] = [
+  { text: '介绍', link: '/guide/' },
+]
+
+const vue3VantMobile: DefaultTheme.NavItemWithLink[] = [
+  { text: '概述', link: '/vue3-vant-mobile/' },
+]
+
+const vue3VarletMobile: DefaultTheme.NavItemWithLink[] = [
+  { text: '概述', link: '/vue3-varlet-mobile/' },
+]
+
+const nuxt3VantMobile: DefaultTheme.NavItemWithLink[] = [
+  { text: '概述', link: '/nuxt3-vant-mobile/' },
+]
+
+const vue3ElementAdmin: DefaultTheme.NavItemWithLink[] = [
+  { text: '概述', link: '/vue3-element-admin/' },
+]
+
+const vue3AntdvMobile: DefaultTheme.NavItemWithLink[] = [
+  { text: '概述', link: '/vue3-antdv-admin/' },
+]
+
+const Nav: DefaultTheme.NavItem[] = [
+  {
+    text: '快速开始',
+    items: [
+      {
+        text: '指南',
+        items: Guides,
+      },
+    ],
+    activeMatch: '^/guide/',
+  },
+
+  {
+    text: '移动模板',
+    items: [
+      {
+        text: 'vue3-vant-mobile',
+        link: '/vue3-vant-mobile/',
+      },
+      {
+        text: 'vue3-varlet-mobile',
+        link: '/vue3-varlet-mobile/',
+      },
+      {
+        text: 'nuxt3-vant-mobile',
+        link: '/nuxt3-vant-mobile/',
+      },
+    ]
+  },
+  {
+    text: '中后台模版',
+    items: [
+      {
+        text: 'vue3-antdv-admin',
+        link: '/vue3-antdv-admin/',
+      },
+      {
+        text: 'vue3-element-admin',
+        link: '/vue3-element-admin/',
+      }
+    ]
+  },
+]
+
+const SidebarGuide: DefaultTheme.SidebarItem[] = [
+  {
+    text: '指南',
+    items: Guides,
+  },
+  {
+    text: '移动模板',
+    items: [
+      {
+        text: 'vue3-vant-mobile',
+        link: '/vue3-vant-mobile/',
+      },
+      {
+        text: 'vue3-varlet-mobile',
+        link: '/vue3-varlet-mobile/',
+      },
+      {
+        text: 'nuxt3-vant-mobile',
+        link: '/nuxt3-vant-mobile/',
+      },
+    ],
+  },
+  {
+    text: '中后台模板',
+    items: [
+      {
+        text: 'vue3-antdv-admin',
+        link: '/vue3-antdv-admin/',
+      },
+      {
+        text: 'vue3-element-admin',
+        link: '/vue3-element-admin/',
+      },
+    ],
+  }
+]
+
+const vue3VantMobileSidebarConfig: DefaultTheme.SidebarItem[] = [
+  {
+    text: 'vue3-vant-mobile',
+    collapsed: false,
+    items: vue3VantMobile,
+  },
+]
+
+const vue3VarletMobileSidebarConfig: DefaultTheme.SidebarItem[] = [
+  {
+    text: 'vue3-varlet-mobile',
+    collapsed: false,
+    items: vue3VarletMobile,
+  },
+]
+
+const nuxt3VantMobileSidebarConfig: DefaultTheme.SidebarItem[] = [
+  {
+    text: 'nuxt3-vant-mobile',
+    collapsed: false,
+    items: nuxt3VantMobile,
+  },
+]
+
+const vue3AntdvMobileSidebarConfig: DefaultTheme.SidebarItem[] = [
+  {
+    text: 'vue3-antdv-admin',
+    collapsed: false,
+    items: vue3AntdvMobile,
+  },
+]
+
+const vue3ElementAdminSidebarConfig: DefaultTheme.SidebarItem[] = [
+  {
+    text: 'vue3-element-admin',
+    collapsed: false,
+    items: vue3ElementAdmin,
+  },
+]
+
+
+export default defineConfig({
+  title: 'EasyTemplate',
+
+  lastUpdated: true,
+  cleanUrls: true,
+  metaChunk: true,
+
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
+    ['link', { rel: 'icon', type: 'image/png', href: '/logo.png' }],
+    ['meta', { name: 'theme-color', content: '#55a578' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    ['meta', { property: 'og:locale', content: 'zh' }],
+    ['meta', { property: 'og:title', content: 'EasyTemplate | Out of the box Vue 3 template' }],
+    ['meta', { property: 'og:site_name', content: 'EasyTemplate' }],
+    // ['meta', { property: 'og:url', content: '' }],
+  ],
+
+  themeConfig: {
+    logo: { src: '/logo.svg', width: 24, height: 24 },
+
+    search: {
+      provider: 'local',
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/easy-temps' }
+    ],
+
+    nav: Nav,
+
+    sidebar: {
+      '/guide/': SidebarGuide,
+      '/vue3-vant-mobile/': vue3VantMobileSidebarConfig,
+      '/vue3-varlet-mobile/': vue3VarletMobileSidebarConfig,
+      '/nuxt3-vant-mobile/': nuxt3VantMobileSidebarConfig,
+      '/vue3-antdv-admin/': vue3AntdvMobileSidebarConfig,
+      '/vue3-element-admin/': vue3ElementAdminSidebarConfig,
+    },
+
+    editLink: {
+      pattern: 'https://github.com/easy-temps/easy-docs/edit/main/:path',
+      text: '在 GitHub 上编辑此页面',
+    },
+
+    footer: {
+      message: '基于 MIT 许可发布',
+      copyright: '版权所有 © 2022-2024 EasyTemplate',
+    },
+  }
+})

.vitepress/theme/custom.css

@@ -0,0 +1,69 @@
+/**
+ * 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-1: #51a13c;
+  --vp-c-brand-light: #79c961;
+  --vp-c-brand-lighter: #a1f287;
+  --vp-c-brand-dark: #277b16;
+  --vp-c-brand-darker: #005700;
+  --vp-c-brand-next: #55a578;
+
+  --vp-c-indigo-1: #005700;
+  --vp-c-indigo-2: #277b16;
+  --vp-c-indigo-3: #a1f287;
+}
+
+/**
+ * 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-light);
+  --vp-button-brand-hover-border: var(--vp-c-brand-1);
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-1);
+  --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-c-brand-1);
+}
+
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    var(--vp-c-brand-1) 30%,
+    var(--vp-c-brand-next)
+  );
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    var(--vp-c-brand-1) 30%,
+    var(--vp-c-brand-next)
+  );
+  --vp-home-hero-image-filter: blur(80px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(120px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(120px);
+  }
+}

.vitepress/theme/index.ts

@@ -0,0 +1,5 @@
+import DefaultTheme from 'vitepress/theme'
+
+import './custom.css'
+
+export default DefaultTheme

LICENSE

@@ -1,4 +1,4 @@
-MIT License
+# MIT License
 
 Copyright (c) 2024 Easy.Template
 

README.md

@@ -1,2 +1,3 @@
-# easy-docs
-📗 Easy Template 官方文档
+# Easy Docs
+
+Easy Template 官方文档

guide/index.md

@@ -0,0 +1 @@
+# 快速开始

index.md

@@ -0,0 +1,36 @@
+---
+layout: home
+
+title: EasyTemplate
+titleTemplate: Out of the box Vue 3 template
+
+hero:
+  name: EasyTemplate
+  text: 开箱即用的 Vue 3 移动、中后台模板
+  tagline: 帮助你快速完成业务开发
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /guide/
+    - theme: alt
+      text: GitHub
+      link: https://github.com/easy-temps
+  image:
+    src: /logo.svg
+    alt: EasyTemplate
+
+
+features:
+  - icon: ✅
+    title: 专注与您的业务
+    details: 选择合适的模板，即可轻松创建移动 Web，和完善的中后台管理系统
+  - icon: 🚀
+    title: 享受 Vue 3 无可比拟的体验
+    details: 集成了好用的 Vue 3 插件生态，快速进行业务代码的开发和构建
+  - icon: 🚩
+    title: Vant & Varlet 官方社区推荐
+    details: Vue3 生态组件库作者推荐，比官方 Demo 更具特色 和 指导意义 
+  - icon: 📝 
+    title: 不断增加地 Demo 示例组件
+    details: 国际化、暗黑模式、KeepAlive、Unocss、Echarts 等等
+---

nuxt3-vant-mobile/index.md

@@ -0,0 +1,3 @@
+# nuxt3 vant mobile
+
+> ✍ 还未编写，敬请期待