mirror of https://github.com/chaitin/PandaWiki.git
e94b4dfeda
Long file names in the document list were causing the layout to break. This change applies CSS properties (overflow: hidden, white-space: nowrap, text-overflow: ellipsis) to the component responsible for displaying file names, ensuring that long names are truncated with an ellipsis instead of causing misalignment. This addresses issue #30. |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| backend | ||
| images | ||
| web | ||
| LICENSE | ||
| README.md | ||
README.md
🏠 官网 | 📖 帮助文档 | 🔍 演示 Demo | 🙋♂️ 微信交流群
👋 项目介绍
PandaWiki 是一款 AI 驱动的开源知识库搭建系统，借助大模型的力量为你提供 AI 创作、AI 问答、AI 搜索等能力，让你快速拥有智能化的 产品文档、FAQ、博客系统。
🔥 功能与特色
- AI 驱动智能化：AI 辅助创作、AI 辅助问答、AI 辅助搜索。
- 强大的富文本编辑能力：兼容 Markdown 和 HTML，支持导出为 word、pdf、markdown 等多种格式。
- 轻松与第三方应用进行集成：支持做成网页挂件挂在其他网站上，支持做成钉钉、飞书、企业微信等聊天机器人。
- 通过第三方来源导入内容：根据网页 URL 导入、通过网站 Sitemap 导入、通过 RSS 订阅、通过离线文件导入等。
⚡️ 截图
 |
 |
|---|---|
 |
 |
查看 演示 Demo
🚀 上手指南
环境需求
安装 PandaWiki 前请确保你的系统环境符合以下要求
- 操作系统：Linux
- CPU 指令架构：x86_64
- 软件依赖：Docker 20.10.14 版本以上
- 软件依赖：Docker Compose 2.0.0 版本以上
- 推荐资源：1 核 CPU / 2 GB 内存 / 10 GB 磁盘
- 最低资源：1 核 CPU / 1 GB 内存 / 5 GB 磁盘
📦 一键安装
使用 root 权限执行以下命令进行安装
bash -c "$(curl -fsSLk https://release.baizhi.cloud/pandawiki/manager.sh)"
⚙️ 初始化
访问 PandaWiki 控制台
安装完成后，控制台默认监听在 9998 端口，使用浏览器访问 http://127.0.0.1:9998 就能看到登录页面。
默认账号密码会在安装时随机生成，请查看安装命令的输出内容。
⚙️ 配置 AI 大模型
在 PandaWiki 控制台的右上角点击 系统配置 按钮，在弹出窗口中配置供 PandaWiki 使用的大模型。
PandaWiki 目前支持接入以下大模型
- DeepSeek：参考文档 DeepSeek
- OpenAI：ChatGPT 所使用的大模型，参考文档 OpenAI
- Ollama：Ollama 通常是本地部署的大模型，参考文档 Ollama
- 硅基流动：参考文档 SiliconFlow
- 月之暗面：Kimi 所使用的模型，参考文档 Moonshot
- 其他：其他兼容 OpenAI 模型接口的 API
💪 开始使用
完成以上配置后你就可以开始 PandaWiki 了，开始创建文档，并使用 AI 问答功能吧。
社区交流
欢迎加入我们的微信群进行交流。
🙋♂️ 贡献
欢迎提交 Pull Request 或创建 Issue 来帮助改进项目。
📝 许可证
本项目采用 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证。这意味着：
- 你可以自由使用、修改和分发本软件
- 你必须以相同的许可证开源你的修改
- 如果你通过网络提供服务，也必须开源你的代码
- 商业使用需要遵守相同的开源要求