wangxuefeng/low-code
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 初始化文档项目

Browse Source
This commit is contained in:
wangxuefeng
2025-03-11 20:14:32 +08:00
parent 089ad69a96
commit c79cd2f4c2
21 changed files with 694 additions and 828 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/.vitepress/config/en.mts
View File

@@ -5,7 +5,7 @@ import { defineConfig } from 'vitepress';
import { version } from '../../../package.json';
export const en = defineConfig({
description: 'Vben Admin & Enterprise level management system framework',
description: 'y-code-platform & Enterprise level management system framework',
lang: 'en-US',
themeConfig: {
darkModeSwitchLabel: 'Theme',
@@ -55,7 +55,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
items: [
{
link: 'introduction/vben',
text: 'About Vben Admin',
text: 'About y-code-platform',
},
{
link: 'introduction/why',
@@ -163,7 +163,7 @@ function nav(): DefaultTheme.NavItem[] {
text: 'Demo',
items: [
{
text: 'Vben Admin',
text: 'y-code-platform',
items: [
{
link: 'https://www.vben.pro',
@@ -188,7 +188,7 @@ function nav(): DefaultTheme.NavItem[] {
items: [
{
link: 'https://vben.vvbin.cn',
text: 'Vben Admin 2.x',
text: 'y-code-platform 2.x',
},
],
},

13
docs/.vitepress/config/index.mts
View File

@@ -1,7 +1,6 @@
import { withPwa } from '@vite-pwa/vitepress';
import { defineConfigWithTheme } from 'vitepress';
import { en } from './en.mts';
import { shared } from './shared.mts';
import { zh } from './zh.mts';
@@ -9,12 +8,12 @@ export default withPwa(
defineConfigWithTheme({
...shared,
locales: {
en: {
label: 'English',
lang: 'en',
link: '/en/',
...en,
},
// en: {
// label: 'English',
// lang: 'en',
// link: '/en/',
// ...en,
// },
root: {
label: '简体中文',
lang: 'zh-CN',

927
docs/.vitepress/config/index.mts.timestamp-1741673315121-b66c51715d7ce.mjs
View File

File diff suppressed because one or more lines are too long

14
docs/.vitepress/config/shared.mts
View File

@@ -44,12 +44,12 @@ export const shared = defineConfig({
},
provider: 'local',
},
siteTitle: 'Vben Admin',
socialLinks: [
{ icon: 'github', link: 'https://github.com/vbenjs/vue-vben-admin' },
],
siteTitle: 'y-code-platform',
// socialLinks: [
// { icon: 'github', link: 'https://github.com/vbenjs/vue-vben-admin' },
// ],
},
title: 'Vben Admin',
title: 'y-code-platform',
vite: {
build: {
chunkSizeWarningLimit: Infinity,
@@ -144,7 +144,7 @@ function pwa(): PwaOptions {
includeManifestIcons: false,
manifest: {
description:
'Vben Admin is a modern admin dashboard template based on Vue 3. ',
'y-code-platform is a modern admin dashboard template based on Vue 3. ',
icons: [
{
sizes: '192x192',
@@ -158,7 +158,7 @@ function pwa(): PwaOptions {
},
],
id: '/',
name: 'Vben Admin Doc',
name: 'y-code-platform Doc',
short_name: 'vben_admin_doc',
theme_color: '#ffffff',
},

167
docs/.vitepress/config/zh.mts
View File

@@ -5,7 +5,7 @@ import { defineConfig } from 'vitepress';
import { version } from '../../../package.json';
export const zh = defineConfig({
description: 'Vben Admin & 企业级管理系统框架',
description: '悦码 & 低代码管理系统',
lang: 'zh-Hans',
themeConfig: {
darkModeSwitchLabel: '主题',
@@ -14,16 +14,16 @@ export const zh = defineConfig({
next: '下一页',
prev: '上一页',
},
editLink: {
pattern:
'https://github.com/vbenjs/vue-vben-admin/edit/main/docs/src/:path',
text: '在 GitHub 上编辑此页面',
},
footer: {
copyright: `Copyright © 2020-${new Date().getFullYear()} Vben`,
message: '基于 MIT 许可发布.',
},
langMenuLabel: '多语言',
// editLink: {
// pattern:
// 'https://github.com/vbenjs/vue-vben-admin/edit/main/docs/src/:path',
// text: '在 GitHub 上编辑此页面',
// },
// footer: {
// copyright: `Copyright © 2020-${new Date().getFullYear()} Vben`,
// message: '基于 MIT 许可发布.',
// },
// langMenuLabel: '多语言',
lastUpdated: {
formatOptions: {
dateStyle: 'short',
@@ -55,18 +55,13 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: '简介',
items: [
{
link: 'introduction/vben',
text: '关于 Vben Admin',
},
{
link: 'introduction/why',
text: '为什么选择我们?',
link: 'introduction/platform',
text: '关于悦码',
},
{ link: 'introduction/quick-start', text: '快速开始' },
{ link: 'introduction/thin', text: '精简版本' },
{
base: '/',
link: 'components/introduction',
link: 'components/index',
text: '组件文档',
},
],
@@ -75,48 +70,20 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: '基础',
items: [
{ link: 'essentials/concept', text: '基础概念' },
{ link: 'essentials/development', text: '本地开发' },
{ link: 'essentials/route', text: '路由和菜单' },
{ link: 'essentials/settings', text: '配置' },
{ link: 'essentials/icons', text: '图标' },
{ link: 'essentials/styles', text: '样式' },
{ link: 'essentials/external-module', text: '外部模块' },
{ link: 'essentials/build', text: '构建与部署' },
{ link: 'essentials/server', text: '服务端交互与数据Mock' },
],
},
{
text: '深入',
items: [
{ link: 'in-depth/login', text: '登录' },
// { link: 'in-depth/layout', text: '布局' },
{ link: 'in-depth/theme', text: '主题' },
{ link: 'in-depth/access', text: '权限' },
{ link: 'in-depth/locale', text: '国际化' },
{ link: 'in-depth/features', text: '常用功能' },
{ link: 'in-depth/check-updates', text: '检查更新' },
{ link: 'in-depth/loading', text: '全局loading' },
{ link: 'in-depth/ui-framework', text: '组件库切换' },
],
},
{
text: '工程',
items: [
{ link: 'project/standard', text: '规范' },
{ link: 'project/cli', text: 'CLI' },
{ link: 'project/dir', text: '目录说明' },
{ link: 'project/test', text: '单元测试' },
{ link: 'project/tailwindcss', text: 'Tailwind CSS' },
{ link: 'project/changeset', text: 'Changeset' },
{ link: 'project/vite', text: 'Vite Config' },
],
items: [{ link: 'in-depth/features', text: '常用功能' }],
},
{
text: '其他',
items: [
{ link: 'other/project-update', text: '项目更新' },
{ link: 'other/remove-code', text: '移除代码' },
{ link: 'other/faq', text: '常见问题' },
// { link: 'other/project-update', text: '项目更新' },
// { link: 'other/remove-code', text: '移除代码' },
// { link: 'other/faq', text: '常见问题' },
],
},
];
@@ -132,10 +99,6 @@ function sidebarCommercial(): DefaultTheme.SidebarItem[] {
link: 'technical-support',
text: '技术支持',
},
{
link: 'customized',
text: '定制开发',
},
];
}
@@ -205,55 +168,52 @@ function nav(): DefaultTheme.NavItem[] {
items: [
{
activeMatch: '^/guide/',
link: '/guide/introduction/vben',
text: '指南',
link: '/guide/introduction/platform',
text: '低代码平台',
},
{
activeMatch: '^/components/',
link: '/components/introduction',
text: '组件',
activeMatch: '^/materials/',
link: '/materials/index',
text: '物料',
},
{
text: '历史版本',
items: [
{
link: 'https://doc.vvbin.cn',
text: '2.x版本文档',
},
],
activeMatch: '^/renderer/',
link: '/renderer/index',
text: '渲染器',
},
{
activeMatch: '^/designer/',
link: '/designer/index',
text: '设计器',
},
],
},
{
text: '演示',
text: '低代码管理平台',
items: [
{
text: 'Vben Admin',
text: '悦码 2.0',
items: [
{
link: 'https://y-code-platform.shiyuegame.com',
text: '生产版本',
},
{
link: 'https://y-code-platform-pre.shiyue.com',
text: '预发布版本',
},
{
link: 'https://www.vben.pro',
text: '演示版本',
},
{
link: 'https://ant.vben.pro',
text: 'Ant Design Vue 版本',
},
{
link: 'https://naive.vben.pro',
text: 'Naive 版本',
},
{
link: 'https://ele.vben.pro',
text: 'Element Plus版本',
},
],
},
{
text: '其他',
items: [
{
link: 'https://vben.vvbin.cn',
text: 'Vben Admin 2.x',
link: 'https://custom-chart.shiyuegame.com/',
text: '悦码 1.0（已废弃，不再更新功能）',
},
],
},
@@ -267,45 +227,20 @@ function nav(): DefaultTheme.NavItem[] {
text: '更新日志',
},
{
link: 'https://github.com/orgs/vbenjs/projects/5',
link: 'https://doc.weixin.qq.com/smartsheet/s3_Aa0ASwZ0AOEr2TbPuaMRoCvs1yzjA?scode=AOwAYgeoAAkoT6VFa0Aa0ASwZ0AOE&tab=q979lj&viewId=vpDUFs',
text: '路线图',
},
{
link: 'https://github.com/vbenjs/vue-vben-admin/blob/main/.github/contributing.md',
text: '贡献',
},
],
},
{
link: '/commercial/technical-support',
text: '🦄 技术支持',
text: '👨‍👦‍👦 问题反馈',
items: [
{
link: 'https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=22ySzj7pKiw&businessType=9&from=246610&biz=ka&mainSourceId=share&subSourceId=others&jumpsource=shorturl#/pc',
text: '热心大姐',
},
],
},
{
link: '/sponsor/personal',
text: '✨ 赞助',
},
{
link: '/commercial/community',
text: '👨‍👦‍👦 交流群',
// items: [
// {
// link: 'https://qun.qq.com/qqweb/qunpro/share?_wv=3&_wwv=128&appChannel=share&inviteCode=22ySzj7pKiw&businessType=9&from=246610&biz=ka&mainSourceId=share&subSourceId=others&jumpsource=shorturl#/pc',
// text: 'QQ频道',
// },
// {
// link: 'https://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=mjZmlhgVzzUxvdxllB6C1vHpX8O8QRL0&authKey=DBdFbBwERmfaKY95JvRWqLCJIRGJAmKyZbrpzZ41EKDMZ5SR6MfbjOBaaNRN73fr&noverify=0&group_code=4286109',
// text: 'QQ群',
// },
// {
// link: 'https://discord.gg/VU62jTecad',
// text: 'Discord',
// },
// ],
},
// {
// link: '/friend-links/',
// text: '🤝 友情链接',
// },
];
}