History

yu.kuai 75144382bb feat: 支持markdown编辑器		2025-10-31 17:30:18 +08:00
..
api-templates	fix: ts 类型缺失	2025-10-15 19:26:36 +08:00
public	pref: footer, 卡片文案	2025-10-29 18:38:36 +08:00
src	feat: 支持markdown编辑器	2025-10-31 17:30:18 +08:00
.env	feat(fe): base64 粘贴到编辑器支持上传变成url	2025-07-21 09:56:26 +00:00
.gitignore	feat: app集成sentry	2025-09-15 11:10:21 +08:00
.prettierignore	feat: 修改layout, 404, error页面, 接口错误日志	2025-08-11 14:50:41 +08:00
Dockerfile	Merge pull request #1063 from jiangwel/feat-support-sentry	2025-09-15 14:03:14 +08:00
Makefile	feat: contribute	2025-09-17 18:23:30 +08:00
README.md	feat: 修改layout, 404, error页面, 接口错误日志	2025-08-11 14:50:41 +08:00
eslint.config.mjs	feat: 修改layout, 404, error页面, 接口错误日志	2025-08-11 14:50:41 +08:00
new-types.d.ts	fix: 锚点失效问题	2025-09-01 18:30:13 +08:00
next.config.ts	feat: 自定义配置	2025-10-15 15:47:35 +08:00
package.json	feat: 评论区添加图片支持	2025-10-23 14:46:24 +08:00
prettier.config.js	feat: 修改layout, 404, error页面, 接口错误日志	2025-08-11 14:50:41 +08:00
sentry.edge.config.ts	feat: 开发环境去除 sentry, token 更换字段	2025-09-18 12:12:53 +08:00
sentry.server.config.ts	feat: 开发环境去除 sentry, token 更换字段	2025-09-18 12:12:53 +08:00
swagger.api.config.ts	feat: 添加 oauth	2025-07-31 18:39:28 +08:00
tsconfig.json	style: error 样式	2025-08-29 18:54:58 +08:00

README.md

PandaWiki

项目描述

PandaWiki 是一个基于 Next.js 的 Wiki 知识库系统，支持文档管理、搜索和分类功能。

技术栈

前端框架: Next.js 15.3.2, React 19
UI 组件库: Material-UI (@mui/material 7.1.0)
状态管理: 内置 React Hooks
Markdown 解析: markdown-it, react-markdown
代码规范: ESLint, TypeScript 5
包管理: pnpm
API 文档: cx-swagger-api

安装与运行

克隆项目：

git clone https://github.com/your-repo/PandaWiki.git

安装依赖：
```
pnpm install
```

配置环境变量：

在项目根目录下，新建文件 .env.local , 根据需求修改环境变量，实际字段如下：

# 目标服务配置
TARGET=http://your_target_ip:8000 # 后端服务地址
STATIC_FILE_TARGET=https://your_static_file_ip:2443 # 静态文件服务地址

# 开发相关
DEV_KB_ID=your_dev_kb_id # 开发环境知识库ID

# Swagger 配置
SWAGGER_BASE_URL=http://your_swagger_ip:8000 # Swagger API 文档地址
SWAGGER_AUTH_TOKEN=your_swagger_token # Swagger 认证令牌

启动开发服务器：
```
pnpm dev
```
构建生产版本：
```
pnpm build
```
启动生产服务器：
```
pnpm start
```

可用命令

pnpm dev: 开发模式 (端口 3010)
pnpm build: 构建生产版本
pnpm start: 启动生产服务器
pnpm lint: 代码检查
pnpm api: 生成 API 文档(环境变量需提供 SWAGGER_BASE_URL、SWAGGER_AUTH_TOKEN)

开发指南

确保代码符合 ESLint 和 Stylelint 规范。
如需代码格式化，运行：
```
pnpm format
```
提交 Pull Request 时描述清楚改动内容。