docs: 重构API文档结构并更新文档内容

- 将大型API文档拆分为多个分类子文档
- 更新文档内容,添加新的API接口说明
- 修复文档中的格式问题和错别字
- 添加反馈文档和Github链接
- 优化侧边栏结构,支持不同路径的独立配置
This commit is contained in:
anghunk
2026-01-22 10:38:33 +08:00
parent 2fa0e04508
commit 17c31d7a1b
16 changed files with 1451 additions and 1333 deletions

View File

@@ -1,5 +1,5 @@
import nav from './configs/nav';
import sidebar from './configs/sidebar';
import { rootSidebar, apiSidebar } from './configs/sidebar';
import { defineConfig } from 'vitepress';
export default defineConfig({
@@ -17,7 +17,10 @@ export default defineConfig({
],
themeConfig: {
nav,
sidebar,
sidebar: {
'/': rootSidebar,
'/api/': apiSidebar,
},
outline: {
level: [2, 3],
label: 'On this page',

View File

@@ -1,4 +1,4 @@
export default [
export const rootSidebar = [
{
text: '快速开始',
items: [
@@ -17,13 +17,28 @@ export default [
{ text: '数据迁移', link: '/function/data-migration' },
],
},
{ text: '反馈', link: '/guide/feedback' },
];
export const apiSidebar = [
{
text: 'API 文档',
items: [
{ text: '概览', link: '/api/overview' },
{ text: '公开 API', link: '/api/public' },
{ text: '管理员 API', link: '/api/admin' },
{
text: '管理员 API',
items: [
{ text: '概览', link: '/api/admin' },
{ text: '身份认证', link: '/api/admin/auth' },
{ text: '评论管理', link: '/api/admin/comments' },
{ text: '数据迁移', link: '/api/admin/data-migration' },
{ text: '评论设置', link: '/api/admin/settings' },
{ text: '邮件通知', link: '/api/admin/email-notify' },
{ text: '统计数据', link: '/api/admin/stats' },
{ text: '访问统计', link: '/api/admin/analytics' },
],
},
],
},
{ text: '反馈', link: '/feedback' },
];