Skip to content

安装与包地址

包列表

在线文档:https://lumal-docs-cf.pages.dev

包名本地路径文档npm / 外链(占位→正式)
@lumal/corepackages/core/packages/corehttps://www.npmjs.com/package/@lumal/core
@lumal/iconspackages/icons/packages/icons同上规则
@lumal/icons-vuepackages/icons-vue/packages/icons-vue同上
@lumal/chartspackages/charts/packages/charts同上
@lumal/datavpackages/datav/packages/datav同上
@lumal/cockpitpackages/cockpit/packages/cockpit同上
@lumal/vitepackages/vite/packages/vite同上
@lumal/vben-compatpackages/vben-compat/packages/vben-compat同上
create-lumal-adminpackages/create-lumal-admin/packages/create-lumal-admin同上

正式安装(发布后)

bash
pnpm add @lumal/core @lumal/icons @lumal/icons-vue element-plus vue vue-router pinia
pnpm add @lumal/charts echarts vue-echarts   # 可选
pnpm add @lumal/datav echarts               # 可选
pnpm add @lumal/cockpit                     # 可选
pnpm add -D @lumal/vite
pnpm add @lumal/vben-compat                 # 迁移

本地 monorepo

json
{
  "dependencies": {
    "@lumal/core": "workspace:*",
    "@lumal/icons": "workspace:*",
    "@lumal/icons-vue": "workspace:*"
  }
}

外部项目 file 依赖

bash
pnpm add @lumal/core@file:../lumal/packages/core

使用前在 monorepo 根目录 pnpm build

环境变量(文档构建)

变量含义默认
LUMAL_DOCS_URL文档站根https://lumal-docs-cf.pages.dev
LUMAL_ADMIN_DEMO_URLAdmin 演示https://lumal-admin-demo.vercel.app
LUMAL_COCKPIT_DEMO_URL驾驶舱演示https://lumal-cockpit-demo.vercel.app
LUMAL_DATAV_GUIDE_URLDataV 指南https://lumal-datav-guide.vercel.app
LUMAL_GITHUB_URL仓库https://github.com/cuteyuchen/lumal
LUMAL_NPM_*各包 npm 页对应的 npm 正式包页面

配置文件:apps/lumal-docs/src/.vitepress/config/links.ts

Peer 依赖摘要

见各 包文档 页内说明。

基于 MIT 许可发布 · Vue 3 · TypeScript · Vite · Element Plus