Skip to content

公开展示 ​

当你打磨 Super Admin 的 GitHub repository、npm package pages、docs links、release notes 或 social preview 时,使用这份清单。

当前公开状态 ​

截至 2026-07-25:

  • 仓库公开地址是 lineo7387/super-admin。
  • npm latest 与 next 已指向 smoke-verified release line:
    • create-super-admin@0.2.0
    • @super-admin-org/core@0.2.0
    • @super-admin-org/theme@0.1.5
    • @super-admin-org/theme-base@0.1.4
    • @super-admin-org/theme-crypto@0.1.4
    • @super-admin-org/theme-cyberpunk@0.1.4
    • @super-admin-org/theme-industrial@0.1.4
    • @super-admin-org/theme-newsprint@0.1.4
    • @super-admin-org/ui@0.1.6
  • GitHub Pages 文档 URL 是 https://lineo7387.github.io/super-admin/,完整 mock-backed admin demo 是 https://lineo7387.github.io/super-admin/demo/。
  • 公开安装路径可用:
bash
npm create super-admin@latest my-admin

Root package 是 private,不会发布。已发布 package set 见 发布流程。

GitHub About Settings ​

这些设置在 GitHub 管理,不在仓库文件里。

推荐值:

  • Description: Frontend-first Vue admin template with reusable UI primitives, runtime themes, mock data, and replaceable API adapters.
  • Website: https://lineo7387.github.io/super-admin/
  • Topics: vue, vite, typescript, admin-dashboard, admin-template, frontend, design-system, pinia, tanstack-query, vitepress
  • Social preview: 使用 admin shell、theme/profile switching 和 example modules 的截图或组合预览图。

README Surface ​

README 首屏应保留:

  • create-super-admin 的 npm badge。
  • 反映当前公开状态的 package 或 license badges。
  • npm create super-admin@latest my-admin。
  • hosted docs/demo、getting started、examples、API adapters、themes/layouts 和 public presentation 链接。
  • 明确说明 backend、database、auth provider、AI provider 和 generated schema 都是可选的。

GitHub Release badge 应使用 GitHub 提供的动态 latest release 状态,避免硬编码具体版本。只有 GitHub Pages workflow 存在后才使用 docs/demo badge。

链接放置建议:

  • README:Quick Start 附近放短的 "Preview And Docs" 区块。
  • VitePress nav/sidebar:public presentation 与 releasing、open-source workflow 一起放进维护者区域。
  • GitHub About website:部署成功后使用 https://lineo7387.github.io/super-admin/。
  • Release notes:链接到 README、Getting Started、Examples、API adapters、Themes and layouts 和 Releasing。

公开 demo 由 canonical apps/admin 静态构建而来,不要求 backend、database、auth provider 或 AI provider。登录信息显示在页面中。维护者也可以本地运行同一 app:

bash
pnpm install
pnpm dev

Screenshot And Demo Assets ​

当前已交付:

  • docs/public/super-admin-shell.png:由 scripts/admin-browser-smoke.mjs 的真实 Chromium 用户链路捕获,展示 Cyberpunk dark profile、Top header、workspace tabs 和 mock-backed Users module。
  • /demo/:由 pnpm docs:build 同时构建到 GitHub Pages artifact 的完整静态 admin。

后续可选资产:

  • docs/public/super-admin-themes.gif:切换 design profiles 的短循环。
  • docs/public/create-super-admin.gif:从 npm create super-admin@latest my-admin 到 npm run dev 的终端流程。

重新生成截图时运行 ADMIN_SMOKE_SCREENSHOT_PATH=docs/public/super-admin-shell.png pnpm test:browser,并在提交前人工检查。若公开页面需要 responsive proof,再添加 mobile 或窄屏截图。不要提交模糊或纯氛围图;访问者应该能看清真实产品 UI。

Release And Tag Copy ​

v0.2.0 GitHub Release 推荐 title:

text
Super Admin v0.2.0 - readable extension contracts & built-in quality

推荐 summary:

text
Super Admin v0.2.0 makes extensibility source-readable and type-safe through immutable module manifests and typed layout/auth registries, while generated starters now ship a runnable quality baseline by default.

推荐 highlights:

  • npm create super-admin@latest my-admin
  • create-super-admin@0.2.0 on npm latest and next
  • immutable feature manifest composition keeps navigation, routes, route meta, and permissions in one source-readable contract
  • typed layout and auth recipe registries provide exact component contracts, duplicate detection, and neutral fallbacks
  • generated standard starters include ESLint, Vitest, typecheck/build/check scripts, while --minimal is the explicit lightweight opt-out
  • capability-aware AGENTS.md and ai-context/ document the real manifest/layout/auth extension seams without requiring an AI provider
  • @super-admin-org/ui exposes Vue as a peer runtime instead of bundling a second copy into shared UI output
  • packed starter validation covers default, multi-theme+i18n, ECharts, and minimal output, with registry smoke for default and all theme profiles
  • the default starter remains frontend-first and mock-backed; backend, database, auth provider, AI provider, and maintainer release tooling remain optional

推荐 package matrix(均位于 npm latest 与 next):

  • create-super-admin@0.2.0
  • @super-admin-org/core@0.2.0
  • @super-admin-org/theme@0.1.5
  • @super-admin-org/theme-base@0.1.4
  • @super-admin-org/theme-crypto@0.1.4
  • @super-admin-org/theme-cyberpunk@0.1.4
  • @super-admin-org/theme-industrial@0.1.4
  • @super-admin-org/theme-newsprint@0.1.4
  • @super-admin-org/ui@0.1.6

只有确认 release commit、npm dist-tags 和 generated starter smoke result 后,才创建 tags/releases。

Maintainer Tooling Boundary ​

源码仓库可以包含 .trellis/、.agents/、.agent/、.claude/、.codex/、.mcp.json、skills-lock.json 和 CodeGraph-related files。这些是维护者 workflow aids。

保守策略:

  • 不要在 public-presentation polish 中移除或迁移它们。
  • 不要复制进 generated starters。
  • 不要描述成普通用户必需设置。
  • 当它们出现在 public docs 中时,解释为可选 maintainer/contributor aids。

只有团队决定把 public tree 中的维护者 workflow tooling 拆到另一个 repository 或 package 时,才创建单独迁移任务。