中文 | English
🚀 您的MkDocs文档首选智能摘要！
这个项目利用MkDocs hooks，为您的技术文档和博客添加AI驱动的摘要生成和智能阅读统计功能。
个人博客：wcowin.work/
- 🤖 多 AI 服务支持 – 支持 DeepSeek、OpenAI、Google Gemini、GLM 等主流 AI 服务
- ⚡ 智能缓存系统 – 避免重复 API 调用，大幅提升构建速度
- 🌍 多语言支持 – 支持中英文等多种语言，页面级语言控制
- 🔄 自动降级机制 – 主服务不可用时自动切换备用服务，确保稳定性
- 🚀 CI/CD 友好 – 专为持续集成环境优化，支持缓存策略
- 🎨 完美兼容 – 与所有 MkDocs 主题无缝集成
从 PyPI 安装（推荐）
1. 基本配置
在 中添加插件：
2. 获取 API 密钥
推荐使用 GLM（性价比最高）：
- 访问 GLM 开放平台
- 注册并创建 API 密钥
- 在项目根目录创建 文件：
3. 构建文档
现在开始，您的文档页面顶部会自动显示 AI 生成的摘要！
完整配置示例
多 AI 服务配置
在 文件中配置多个服务作为备用：
页面级语言控制
在页面的 front matter 中指定摘要语言：
核心配置选项
本地开发配置
步骤1：获取API密钥
根据您选择的AI服务，获取相应的API密钥：
DeepSeek (推荐)
- 访问 DeepSeek官网
- 注册账号并登录
- 进入API管理页面
- 创建新的API密钥
- 复制密钥备用
OpenAI
- 访问 OpenAI Platform
- 登录您的账号
- 进入API Keys页面
- 点击”Create new secret key”
- 复制密钥备用
Google Gemini
- 访问 Google AI Studio
- 登录Google账号
- 创建新的API密钥
- 复制密钥备用
GLM (智谱AI)(最推荐)
- 访问 智谱AI开放平台
- 注册并登录账号
- 进入API管理
- 创建API密钥
- 复制密钥备用
步骤2：创建.env文件
在您的项目根目录（与同级）创建文件：
步骤3：配置API密钥
编辑文件，添加您的API密钥：
重要提示：
- 只需要配置您计划使用的AI服务的API密钥
- 确保文件已添加到中，避免泄露API密钥
- API密钥格式因服务而异，请确保复制完整的密钥
步骤4：验证配置
运行以下命令验证配置是否正确：
如果配置正确，您应该能看到插件成功加载并生成AI摘要。
GitHub部署配置
1. 添加 API 密钥到 GitHub Secrets
在您的 GitHub 仓库中：
- 进入 Settings → Secrets and variables → Actions
- 添加新的 secret：
- 将您的 API 密钥粘贴进去
2. 配置 GitHub Actions 工作流
方案 A：创建新的工作流
创建 文件：
方案 B：在现有工作流中添加
如果您已经有 文件，请在现有工作流中添加以下步骤：
现有工作流集成详细步骤
如果您已经有一个正常工作的 文件，请按照以下步骤添加 AI 摘要功能：
步骤 1：添加插件安装
在您现有的依赖安装部分添加这一行：
步骤 2：添加 API 密钥到环境变量
更新您的 mkdocs 构建/部署步骤，包含 API 密钥：
步骤 3：配置 AI 摘要设置（可选）
为了更好的 CI 性能，添加这些环境变量：
步骤 4：添加缓存管理（推荐/可选）
要自动提交生成的缓存文件，在部署后添加此步骤：
4. 启用 GitHub Pages
在仓库设置中启用 GitHub Pages，选择 分支作为源。
缓存管理
插件会自动缓存生成的摘要，避免重复 API 调用：
多 AI 服务配置
配置主服务和备用服务，确保稳定性：
常见问题
Q: 插件不生成摘要？
- 检查 API 密钥配置
- 确保 （本地开发）
- 验证文件在 中
Q: CI 构建失败？
- 确认 GitHub Secrets 中已添加 API 密钥
- 检查工作流文件中的环境变量名称
- 确保插件已在工作流中安装
Q: 如何清除缓存？
- 配置中设置
- 或手动删除 目录
支持
- 📖 文档
- 🐛 问题跟踪
- 💬 讨论
- 📧 邮件支持
贡献代码
我们欢迎各种形式的贡献：
- 🐛 报告 Bug
- 💡 提出新功能建议
- 📝 改进文档
- 🔧 提交代码
Q: 插件不生成摘要？
- 检查 API 密钥配置
- 确保 （本地开发）
- 验证文件在 中
Q: CI 构建失败？
- 确认 GitHub Secrets 中已添加 API 密钥
- 检查工作流文件中的环境变量名称
- 确保插件已在工作流中安装
Q: 如何清除缓存？
- 配置中设置
- 或手动删除 目录
本项目采用 MIT 许可证
- MkDocs – 本插件扩展的静态站点生成器
- MkDocs Material – 启发我们设计的美观主题
- 所有使这个插件成为可能的 AI 服务提供商
Telegram
微信交流
智谱 AI GLM 教程
如果这个项目对您有帮助，请给它一个 ⭐ Star！
用 ❤️ 为 MkDocs 社区制作
发布者：Ai探索者，转载请注明出处：https://javaforall.net/263567.html原文链接：https://javaforall.net
