diff --git a/README.md b/README.md index ba7a656..8501328 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ npm run docs:build ```md npm run docs:preview ``` -## 如何添加或修改目录 -在docs/.vitepress/config.mts中的sidebar进行修改,text为目录的描述内容,link为点击目录后加载的内容的链接,如果有子目录,在items进行修改 +## 如何添加或修改侧边栏 +在docs/.vitepress/config.mts中的sidebar进行修改,对于不同路径下的侧边栏,分别使用不同函数得到,text为侧边栏的描述内容,link为点击侧边栏后加载的内容的链接,如果有子目录,在items进行修改 + link链接的内容既可以是网页链接,也可以是本地文档 +## 如何自定义网站样式 +在docs/.vitepress/theme/style.css中自定义网站样式 + diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index dcead26..9e36ade 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,4 +1,5 @@ import { defineConfig } from 'vitepress' +import type { DefaultTheme } from 'vitepress' import { set_sidebar } from "../utils/auto_sidebar.js"; // https://vitepress.dev/reference/site-config @@ -17,170 +18,24 @@ export default defineConfig({ src: '/mnsoftware.png', }, nav: [ - { text: '文档', link: '/document/index' }, + // { text: '文档', link: '/document/index' }, + { + text: '文档', + items: [ + { + text: 'Devstar介绍文档', + link: '/document/index' + }, + ] + }, { text: 'API', link: 'https://docs.gitea.com/zh-cn/api/1.24/' }, - { text: 'Runner', link: 'https://docs.gitea.com/zh-cn/runner/0.2.11/' }, - { text: 'Enterprise', link: 'https://docs.gitea.com/enterprise/' }, + { text: 'Runner', link: 'runner/index' }, + { text: 'Enterprise', link: '/enterprise/index' }, ], - sidebar: [ - { - text: 'devstar是什么', - link: '/document/index', - } as any, - { - text: '安装', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '对比Gitea与其它Git托管工具', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, - { text: '数据库准备', link: 'https://docs.gitea.com/zh-cn/installation/database-prep' }, - { text: '使用二进制文件安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-binary' }, - { text: '包管理器安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-package' }, - { text: '使用源代码安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-source' }, - { text: '在Linux中以service方式运行', link: 'https://docs.gitea.com/zh-cn/installation/linux-service' },// - { text: '注册为Windows服务', link: 'https://docs.gitea.com/zh-cn/installation/windows-service' }, - { text: '使用Docker安装(rootless)', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker-rootless' }, - { text: '使用Docker安装', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker' }, - { text: '在Kubernetes中安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-kubernetes' }, - { text: '在云服务器上安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-cloud-provider' }, - { text: '从旧版Gitea升级', link: 'https://docs.gitea.com/zh-cn/installation/upgrade-from-gitea' }, - ] - } as any, - { - text: '管理', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '命令行', link: 'https://docs.gitea.com/zh-cn/administration/command-line' }, - { text: '认证', link: 'https://docs.gitea.com/zh-cn/administration/authentication' }, - { text: '环境变量清单', link: 'https://docs.gitea.com/zh-cn/administration/environment-variables' }, - { text: '备份与恢复', link: 'https://docs.gitea.com/zh-cn/administration/backup-and-restore' }, - { text: 'Email设置', link: 'https://docs.gitea.com/zh-cn/administration/email-setup' }, - { text: 'Git LFS设置', link: 'https://docs.gitea.com/zh-cn/administration/git-lfs-setup' }, - { text: 'HTTPS配置', link: 'https://docs.gitea.com/zh-cn/administration/https-setup' }, - { text: '设置Fail2ban', link: 'https://docs.gitea.com/zh-cn/administration/fail2ban-setup' }, - { text: '反向代理', link: 'https://docs.gitea.com/zh-cn/administration/reverse-proxies' }, - { text: '嵌入资源提取工具', link: 'https://docs.gitea.com/zh-cn/administration/cmd-embedded' }, - { text: '配置说明', link: 'https://docs.gitea.com/zh-cn/administration/config-cheat-sheet' }, - { text: '日志配置', link: 'https://docs.gitea.com/zh-cn/administration/logging-config' }, - { text: '邮件模板', link: 'https://docs.gitea.com/zh-cn/administration/mail-templates' }, - { text: '仓库索引器', link: 'https://docs.gitea.com/zh-cn/administration/repo-indexer' }, - { text: 'GPG提交签名', link: 'https://docs.gitea.com/zh-cn/administration/signing' }, - { text: '外部渲染器', link: 'https://docs.gitea.com/zh-cn/administration/external-renderers' }, - { text: '搜索引擎索引', link: 'https://docs.gitea.com/zh-cn/administration/search-engines-indexation' }, - { text: '自定义Gitea配置', link: 'https://docs.gitea.com/zh-cn/administration/customizing-gitea' }, - { text: '添加法律页面', link: 'https://docs.gitea.com/zh-cn/administration/adding-legal-pages' } - ] - } as any, - { - text: '使用', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { - text: 'Actions', - collapsible: true, // 使整个组可折叠 - collapsed: false, // 默认展开 - items: [ - { text: 'Overview', link: 'https://docs.gitea.com/zh-cn/usage/actions/overview' }, - { text: '快速入门', link: 'https://docs.gitea.com/zh-cn/usage/actions/quickstart' }, - { text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/usage/actions/comparison' }, - { text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/usage/actions/act-runner' }, - { text: '变量', link: 'https://docs.gitea.com/zh-cn/usage/actions/actions-variables' }, - { text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/usage/actions/design' }, - { text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/usage/actions/secrets' }, - { text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/usage/actions/faq' }, - { text: 'Badge', link: 'https://docs.gitea.com/zh-cn/usage/actions/badge' } - ] - }, - { - text: '软件包', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/overview' }, - { text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/alpine' }, - { text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/arch' }, - { text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cargo' }, - { text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/chef' }, - { text: '存储', link: 'https://docs.gitea.com/zh-cn/usage/packages/storage' }, - { text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/composer' }, - { text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conan' }, - { text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conda' }, - { text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/container' }, - { text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cran' }, - { text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/go' }, - { text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/helm' }, - { text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/maven' }, - { text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/npm' }, - { text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/nuget' }, - { text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pub' }, - { text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pypi' }, - { text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/packages/rpm' }, - { text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/rubygems' }, - { text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/swift' }, - { text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/vagrant' }, - { text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/generic' }, - { text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/debian' } - ] - }, - { text: 'AGit', link: 'https://docs.gitea.com/zh-cn/usage/agit' }, - { text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/usage/profile-readme' }, - { text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/usage/blame' }, - { text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/usage/incoming-email' }, - { text: '标签', link: 'https://docs.gitea.com/zh-cn/usage/labels' }, - { text: '合并请求', link: 'https://docs.gitea.com/zh-cn/usage/pull-request' }, - { text: '权限', link: 'https://docs.gitea.com/zh-cn/usage/permissions' }, - { text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/usage/template-repositories' }, - { text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/usage/issue-pull-request-templates' }, - { text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/usage/automatically-linked-references' }, - { text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/usage/merge-message-template' }, - { text: '推送', link: 'https://docs.gitea.com/zh-cn/usage/push' }, - { text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/usage/blocking-user' }, - { text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/usage/clone-filters' }, - { text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/usage/code-owners' }, - { text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/usage/webhooks' }, - { text: 'Migration', link: 'https://docs.gitea.com/zh-cn/usage/migration' }, - { text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/usage/protected-tags' }, - { text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/usage/repo-mirror' }, - { text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/usage/markdown' }, - { text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/usage/multi-factor-authentication' } - ] - } as any, - { - text: '开发', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/development/hacking-on-gitea' }, - { text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/development/api-usage' }, - { text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/development/oauth2-provider' }, - { text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/development/migrations-interfaces' }, - { text: '集成', link: 'https://docs.gitea.com/zh-cn/development/integrations' } - ] - } as any, - { - text: '贡献', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-backend' }, - { text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-frontend' }, - { text: '重构指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-refactoring' }, - { text: '本地化', link: 'https://docs.gitea.com/zh-cn/contributing/localization' } - ] - } as any, - { - text: '帮助', - collapsible: true, // 使整个组可折叠 - collapsed: true, // 默认展开 - items: [ - { text: '常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' }, - { text: '支持选项', link: 'https://docs.gitea.com/zh-cn/help/support' }, - ] - } as any, - ], - + sidebar: { + '/document/': sidebarDocument(), // 直接返回 SidebarItem[] + '/enterprise/': sidebarEnterprise() + }, socialLinks: [ { icon: 'github', link: ' https://github.com/mengning/DevStar' } ], @@ -209,3 +64,237 @@ export default defineConfig({ }, } }) + +function sidebarDocument(): DefaultTheme.SidebarItem[] { + return [ + { + text: 'Devstar是什么', + link: '/document/index', + items: [] + } as any, + { + text: '安装', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '对比Gitea与其它Git托管工具', link: 'https://docs.gitea.com/zh-cn/installation/comparison' }, + { text: '数据库准备', link: 'https://docs.gitea.com/zh-cn/installation/database-prep' }, + // { text: '数据库准备', link: '/document/installation/from-source' }, + { text: '使用shell脚本安装', link: '/document/installation/install-via-shell-script' }, + { text: '使用二进制文件安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-binary' }, + { text: '包管理器安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-package' }, + { text: '使用源代码安装', link: 'https://docs.gitea.com/zh-cn/installation/install-from-source' }, + { text: '在Linux中以service方式运行', link: 'https://docs.gitea.com/zh-cn/installation/linux-service' },// + { text: '注册为Windows服务', link: 'https://docs.gitea.com/zh-cn/installation/windows-service' }, + { text: '使用Docker安装(rootless)', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker-rootless' }, + { text: '使用Docker安装', link: 'https://docs.gitea.com/zh-cn/installation/install-with-docker' }, + { text: '在Kubernetes中安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-kubernetes' }, + { text: '在云服务器上安装Gitea', link: 'https://docs.gitea.com/zh-cn/installation/install-on-cloud-provider' }, + { text: '从旧版Gitea升级', link: 'https://docs.gitea.com/zh-cn/installation/upgrade-from-gitea' }, + ] + } as any, + { + text: '管理', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '命令行', link: 'https://docs.gitea.com/zh-cn/administration/command-line' }, + { text: '认证', link: 'https://docs.gitea.com/zh-cn/administration/authentication' }, + { text: '环境变量清单', link: 'https://docs.gitea.com/zh-cn/administration/environment-variables' }, + { text: '备份与恢复', link: 'https://docs.gitea.com/zh-cn/administration/backup-and-restore' }, + { text: 'Email设置', link: 'https://docs.gitea.com/zh-cn/administration/email-setup' }, + { text: 'Git LFS设置', link: 'https://docs.gitea.com/zh-cn/administration/git-lfs-setup' }, + { text: 'HTTPS配置', link: 'https://docs.gitea.com/zh-cn/administration/https-setup' }, + { text: '设置Fail2ban', link: 'https://docs.gitea.com/zh-cn/administration/fail2ban-setup' }, + { text: '反向代理', link: 'https://docs.gitea.com/zh-cn/administration/reverse-proxies' }, + { text: '嵌入资源提取工具', link: 'https://docs.gitea.com/zh-cn/administration/cmd-embedded' }, + { text: '配置说明', link: 'https://docs.gitea.com/zh-cn/administration/config-cheat-sheet' }, + { text: '日志配置', link: 'https://docs.gitea.com/zh-cn/administration/logging-config' }, + { text: '邮件模板', link: 'https://docs.gitea.com/zh-cn/administration/mail-templates' }, + { text: '仓库索引器', link: 'https://docs.gitea.com/zh-cn/administration/repo-indexer' }, + { text: 'GPG提交签名', link: 'https://docs.gitea.com/zh-cn/administration/signing' }, + { text: '外部渲染器', link: 'https://docs.gitea.com/zh-cn/administration/external-renderers' }, + { text: '搜索引擎索引', link: 'https://docs.gitea.com/zh-cn/administration/search-engines-indexation' }, + { text: '自定义Gitea配置', link: 'https://docs.gitea.com/zh-cn/administration/customizing-gitea' }, + { text: '添加法律页面', link: 'https://docs.gitea.com/zh-cn/administration/adding-legal-pages' } + ] + } as any, + { + text: '使用', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { + text: 'Actions', + collapsible: true, // 使整个组可折叠 + collapsed: false, // 默认展开 + items: [ + { text: 'Overview', link: 'https://docs.gitea.com/zh-cn/usage/actions/overview' }, + { text: '快速入门', link: 'https://docs.gitea.com/zh-cn/usage/actions/quickstart' }, + { text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/usage/actions/comparison' }, + { text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/usage/actions/act-runner' }, + { text: '变量', link: 'https://docs.gitea.com/zh-cn/usage/actions/actions-variables' }, + { text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/usage/actions/design' }, + { text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/usage/actions/secrets' }, + { text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/usage/actions/faq' }, + { text: 'Badge', link: 'https://docs.gitea.com/zh-cn/usage/actions/badge' } + ] + }, + { + text: '软件包', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/overview' }, + { text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/alpine' }, + { text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/arch' }, + { text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cargo' }, + { text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/chef' }, + { text: '存储', link: 'https://docs.gitea.com/zh-cn/usage/packages/storage' }, + { text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/composer' }, + { text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conan' }, + { text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conda' }, + { text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/container' }, + { text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cran' }, + { text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/go' }, + { text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/helm' }, + { text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/maven' }, + { text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/npm' }, + { text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/nuget' }, + { text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pub' }, + { text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pypi' }, + { text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/packages/rpm' }, + { text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/rubygems' }, + { text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/swift' }, + { text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/vagrant' }, + { text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/generic' }, + { text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/debian' } + ] + }, + { text: 'AGit', link: 'https://docs.gitea.com/zh-cn/usage/agit' }, + { text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/usage/profile-readme' }, + { text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/usage/blame' }, + { text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/usage/incoming-email' }, + { text: '标签', link: 'https://docs.gitea.com/zh-cn/usage/labels' }, + { text: '合并请求', link: 'https://docs.gitea.com/zh-cn/usage/pull-request' }, + { text: '权限', link: 'https://docs.gitea.com/zh-cn/usage/permissions' }, + { text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/usage/template-repositories' }, + { text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/usage/issue-pull-request-templates' }, + { text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/usage/automatically-linked-references' }, + { text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/usage/merge-message-template' }, + { text: '推送', link: 'https://docs.gitea.com/zh-cn/usage/push' }, + { text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/usage/blocking-user' }, + { text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/usage/clone-filters' }, + { text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/usage/code-owners' }, + { text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/usage/webhooks' }, + { text: 'Migration', link: 'https://docs.gitea.com/zh-cn/usage/migration' }, + { text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/usage/protected-tags' }, + { text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/usage/repo-mirror' }, + { text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/usage/markdown' }, + { text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/usage/multi-factor-authentication' } + ] + } as any, + { + text: '开发', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/development/hacking-on-gitea' }, + { text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/development/api-usage' }, + { text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/development/oauth2-provider' }, + { text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/development/migrations-interfaces' }, + { text: '集成', link: 'https://docs.gitea.com/zh-cn/development/integrations' } + ] + } as any, + { + text: '贡献', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-backend' }, + { text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-frontend' }, + { text: '重构指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-refactoring' }, + { text: '本地化', link: 'https://docs.gitea.com/zh-cn/contributing/localization' } + ] + } as any, + { + text: '帮助', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { text: '常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' }, + { text: '支持选项', link: 'https://docs.gitea.com/zh-cn/help/support' }, + ] + } as any, + ] +} + +function sidebarEnterprise(): DefaultTheme.SidebarItem[] { + return [ + { + text: 'Gitea Enterprise 是什么', + link: '/enterprise/index', + items: [ + + ] + }, + { + text: '特征', + collapsible: true, // 使整个组可折叠 + collapsed: true, // 默认展开 + items: [ + { + text: '可继承分支保护', + link: 'https://docs.gitea.com/enterprise/features/inheritable-branch-protection' + }, + { + text: '依赖关系扫描', + link: 'https://docs.gitea.com/enterprise/features/dependency-scan' + }, + { + text: 'IP 允许列表', + link: 'https://docs.gitea.com/enterprise/features/ip-allowlist' + }, + { + text: '企业主题', + link: 'https://docs.gitea.com/enterprise/features/enterprise-theme' + }, + { + text: '强制2FA身份验证', + link: 'https://docs.gitea.com/enterprise/features/mandatory-2fa' + }, + { + text: '审计日志', + link: 'https://docs.gitea.com/enterprise/features/audit-log' + }, + { + text: 'SAML', + link: 'https://docs.gitea.com/enterprise/features/saml-auth' + }, + { + text: '发布节奏和版本控制', + link: 'https://docs.gitea.com/enterprise/features/release-cadence' + } + ] + } as any, + { + text: '安装', + link: 'https://docs.gitea.com/enterprise/installation', + items: [] + }, + { + text: '常见问题', + link: 'https://docs.gitea.com/enterprise/faq', + items: [] + }, + ] +} + +function sidebarRunner(): DefaultTheme.SidebarItem[] { + return [ + { + link: '/runner/index', + }, + ] +} + diff --git a/docs/.vitepress/theme/Layout.vue b/docs/.vitepress/theme/Layout.vue deleted file mode 100644 index 4974e17..0000000 --- a/docs/.vitepress/theme/Layout.vue +++ /dev/null @@ -1,22 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index c5d67fb..f776a46 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -1,3 +1,30 @@ +/* .vitepress/theme/style.css */ +:root { + --vp-sidebar-indent: 16px; + /* 基础缩进量 */ +} + +/* 侧边栏 */ +.VPSidebar { + background-color: white !important; +} + +.curtain { + background-color: #fff !important; +} + +/* 首页图片 */ +img.VPImage.image-src { + max-width: 500px !important; + height: 220px !important; + width: 380px !important; +} + +.image-container { + /* height: 350px !important; */ + transform: none !important; +} + /* 强制覆盖主题默认的Logo尺寸 */ .VPImage.logo { height: 150px !important; @@ -9,6 +36,7 @@ margin-left: -40px !important; } +/* home页面title部分 */ .VPNavBar .title { margin-right: 20px !important; } @@ -20,21 +48,99 @@ /* 移除掉目录之间的分割线 */ .group { border-top: 0 !important; - - /* padding-bottom: 0 !important; */ - .items { - font-size: 20px !important; - } + line-height: 24px !important; + padding: 4px 0 !important; } -.group .items { - font-size: 16px !important; - color: #3c3c43 !important; - font-weight: 700px !important; +.VPSidebarItem .level-1 .text { + color: #606770; + /* color: #333333 !important; */ + font-weight: 700 !important; } -/* .VPHero .image-container img { - width: 1000px !important; - height: 300px !important; -} */ \ No newline at end of file + +/* 一级菜单 */ +.VPSidebarItem.level-0 { + padding-left: 0; +} + +.VPSidebarItem.level-0.is-link { + padding-bottom: 0 !important; +} + +/* 展开时 */ +.VPSidebarItem.level-0.collapsible { + padding-bottom: 0 !important; +} + +/* 二级菜单 */ +.VPSidebarItem.level-1 { + padding-left: var(--vp-sidebar-indent); +} + +/* 三级菜单 */ +.VPSidebarItem.level-2 { + padding-left: calc(var(--vp-sidebar-indent) * 2); +} + +/* 箭头图标对齐修正 */ +.VPSidebarItem .indicator { + margin-left: auto; +} + +.VPSidebarItem.collapsed.level-0.collapsible.collapsed { + padding-bottom: 0 !important; +} + + +.item { + padding: 0px 10px; +} + +/* 侧边栏悬停效果 - 匹配图片风格 */ +.item:hover { + background-color: #f5f5f7; + /* 浅灰内背景(与图中一致) */ + color: #3451b2 !important; + /* 深蓝文字(#3451b2) */ + border-radius: 8px; + /* 圆角增大(匹配图中圆角) */ + transition: all 0.3s ease; + /* 增强阴影:横向偏移0,纵向偏移4px,模糊12px,扩散2px,透明度0.15 */ + box-shadow: 10px 4px 12px 2px rgba(0, 0, 0, 0.15); + position: relative; + /* 确保阴影覆盖周围元素 */ + z-index: 1; + /* 提升层级避免阴影被遮挡 */ +} + +h2.text:hover { + /* 浅灰内背景(与图中一致) */ + color: #3451b2 !important; +} + + + + + + +/* 实现黑暗模式适配 */ + +/* 深色模式适配 */ +.dark .VPSidebarItem.collapsed.level-0.collapsible.collapsed:hover { + background-color: #2d2d36; + /* 深灰内背景 */ + color: #5a7eff; + /* 亮蓝文字 */ + box-shadow: 0 4px 12px 2px rgba(0, 0, 0, 0.25); + /* 深色阴影更强 */ +} + +.dark .VPSidebar { + background-color: #1b1b1f !important; +} + +.dark .curtain { + background-color: #1b1b1f !important; +} \ No newline at end of file diff --git a/docs/api-examples.md b/docs/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/docs/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/docs/components/index.vue b/docs/components/index.vue index cf352bb..159ee5f 100644 --- a/docs/components/index.vue +++ b/docs/components/index.vue @@ -58,6 +58,7 @@ export default {