Files
wordpress-plugins/AI SEO 助手/README.md
Snowz 82dc71ab1a docs: 更新许可证为GPL v3并添加LICENSE文件
更新README中的许可证信息,从GPL v2升级到GPL v3,并添加完整的GPL v3许可证文件
2025-08-13 19:00:26 +08:00

334 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# AI SEO Generator - WordPress插件
## 📖 插件简介
AI SEO Generator 是一个强大的WordPress插件利用人工智能技术自动生成SEO优化的标题(Title)、描述(Description)和关键词(Keywords)。插件集成了Dify工作流编排对话型应用API为您的网站内容提供智能化的SEO优化解决方案。
## ✨ 主要功能
### 🤖 AI智能生成
- **自动生成SEO标题**:基于文章内容智能生成吸引人的标题
- **智能描述生成**创建符合搜索引擎要求的meta描述
- **关键词提取**:自动识别和生成相关关键词
- **一键生成**点击按钮即可生成完整的SEO内容
- **支持自定义文章类型**兼容文章、页面及自定义post_type
- **🧭 导航主题适配**:自动识别和利用导航网站的链接和描述信息
### 🎨 用户界面
- **直观的编辑界面**:在文章编辑页面直接操作
- **实时预览**:查看搜索结果页面效果
- **字符计数**:实时显示内容长度和建议
- **SEO质量评分**智能评估SEO内容质量
### 🔧 高级功能
- **前端自动应用**生成的SEO内容自动应用到页面
- **Open Graph标签**使用og:title、og:description等标签避免与WordPress默认标签冲突
- **社交媒体优化**自动添加og:image、og:url等标签提升分享效果
- **支持多种内容类型**:文章、页面等
- **AJAX异步处理**:无需刷新页面
- **快捷键支持**Ctrl+Shift+G快速生成
## 🚀 安装说明
### 方法一:手动安装
1. 下载插件文件到WordPress的 `wp-content/plugins/` 目录
2. 在WordPress后台进入「插件」页面
3. 找到「AI SEO Generator」并点击「启用」
### 方法二:上传安装
1. 将插件文件打包为zip格式
2. 在WordPress后台进入「插件」→「安装插件」
3. 点击「上传插件」并选择zip文件
4. 安装完成后启用插件
## ⚙️ 配置设置
### API配置
1. 进入「设置」→「AI SEO Generator」
2. 配置以下参数:
- **API Key**: 请输入您的Dify API密钥
- **API URL**: 请输入您的Dify API基础URL
3. 选择 **支持的文章类型**(可多选)
- 文章 (post)
- 页面 (page)
- 自定义文章类型如sites、shop等
4. 点击「保存设置」
### 文章类型配置
- 插件会自动检测所有公开的文章类型
- 您可以选择在哪些文章类型的编辑页面显示AI SEO Generator
- 支持主题自定义的post_type如sites、shop、products等
- 如果不选择任何类型,默认支持文章和页面
### API接口说明
- **基础URL**: 您配置的API基础URL
- **端点**: `POST /chat-messages`
- **鉴权方式**: Bearer Token
- **请求头**: `Authorization: Bearer {API_KEY}`
## 📝 使用方法
### 基本使用
1. **编辑文章或页面**
- 进入文章/页面编辑界面
- 在编辑器下方找到「AI SEO Generator」面板
2. **生成SEO内容**
- 点击「生成SEO内容」按钮
- 等待AI处理通常需要几秒钟
- 查看生成的标题、描述和关键词
3. **编辑和优化**
- 根据需要手动调整生成的内容
- 查看实时预览效果
- 参考SEO质量评分进行优化
### 🧭 导航主题适配使用
插件特别针对导航类主题进行了优化,能够自动识别和利用导航网站信息:
#### 支持的自定义字段
- **`_sites_link`**:网站链接地址
- **`_sites_sescribe`**:网站描述信息
#### 功能特点
- 🔍 **自动检测**:插件会自动检测文章中是否包含导航网站信息
- 🎯 **智能优化**针对导航类网站调整AI提示词生成更合适的SEO内容
- 📊 **信息展示**在编辑页面显示检测到的导航信息让用户了解AI使用的数据
- 🎨 **美观界面**为导航信息提供专门的UI展示区域
#### 使用方法
1. 确保您的导航主题将网站信息存储在上述meta字段中
2. 在编辑页面,插件会自动显示检测到的导航信息
3. 点击"生成SEO内容"AI会基于网站链接和描述生成针对性的SEO内容
### 高级功能
- **快捷键**: 使用 `Ctrl+Shift+G` 快速生成SEO内容
- **复制功能**: 点击📋按钮复制内容到剪贴板
- **自动保存**: 内容修改后自动保存
## 🎯 SEO优化建议
### 标题优化
- 长度控制在50-60个字符
- 包含主要关键词
- 具有吸引力和可读性
- 避免关键词堆砌
### 描述优化
- 长度控制在150-160个字符
- 包含相关关键词
- 描述准确且吸引人
- 包含行动号召
### 关键词优化
- 选择3-5个相关关键词
- 避免过度优化
- 确保与内容相关性
- 定期更新和调整
## 📁 文件结构
```
AI-SEO/
├── ai-seo-generator.php # 主插件文件
├── install.php # 安装/卸载脚本
├── admin/
│ ├── settings.php # 设置页面模板
│ └── meta-box.php # 编辑页面meta box模板
├── assets/
│ ├── admin.js # 前端JavaScript功能
│ └── admin.css # 界面样式文件
├── config/
│ └── default-settings.json # 默认配置文件
├── test/
│ └── api-test.php # API测试功能
└── README.md # 完整说明文档
```
## 🔧 技术规格
### 系统要求
- WordPress 5.0+
- PHP 7.4+
- MySQL 5.6+
- 支持cURL扩展
### 兼容性
- 支持所有现代浏览器
- 响应式设计
- 支持多语言
- 兼容主流WordPress主题
## 🛠️ 开发信息
## 📋 版本历史
### v1.0.7 (2025-08-13) - 发布版本
- 🔒 移除所有硬编码的API密钥和URL
- 🚀 创建适合公开发布的安全版本
- 🛡️ 保护敏感测试信息不被泄露
- ⚙️ 保留完整的API配置功能
- 📝 更新文档说明移除测试API信息
### v1.0.6 (2025-08-13)
- 🏷️ 优化SEO标签输出方式
- 📱 使用Open Graph标签替代传统meta标签
- 🔄 避免与WordPress默认meta标签冲突
- 🎯 新增og:title、og:description、og:type、og:url标签
- 🖼️ 自动添加og:image标签当文章有特色图片时
- 🔧 保留keywords标签Open Graph标准未包含
- 📈 提升社交媒体分享效果和SEO兼容性
### v1.0.5 (2025-08-13)
- 🌐 新增导航主题适配功能
- 📊 支持读取wp_postmeta中的导航网站数据
- 🔗 自动识别_sites_link网站链接字段
- 📝 自动识别_sites_sescribe网站描述字段
- 🤖 针对导航类网站优化AI提示词
- 🎨 在编辑页面显示检测到的导航信息
- ✨ 为导航信息添加美观的UI展示
### v1.0.4 (2025-08-13)
- ⏱️ 修复AI生成超时问题
- 🔧 将AJAX超时时间从默认值增加到120秒
- 🌐 将API请求超时时间从30秒增加到120秒
- ⚡ 增加PHP执行时间限制到180秒
- 💬 改进超时错误提示信息
- 🎯 优化用户体验,添加耐心等待提示
### 1.0.3 (2025-08-13)
- ✅ 大幅增强调试功能
- ✅ 添加详细的错误日志记录
- ✅ 改进AJAX错误处理
- ✅ 增加请求和响应的完整日志
- ✅ 优化JSON解析错误检测
- ✅ 提供更准确的错误信息
### 1.0.2 (2025-08-13)
- ✅ 修复Dify API响应解析问题
- ✅ 增强API响应兼容性
- ✅ 支持多种响应格式解析
- ✅ 添加调试日志功能
- ✅ 优化错误处理机制
### 1.0.1 (2025-08-13)
- ✅ 新增自定义文章类型支持
- ✅ 支持sites、shop等自定义post_type
- ✅ 设置页面增加文章类型选择器
- ✅ 自动检测所有公开的文章类型
- ✅ 灵活的文章类型配置管理
### 1.0.0 (2025-08-13)
- ✅ 初始版本发布
- ✅ 基础SEO生成功能
- ✅ Dify API集成
- ✅ 管理界面实现
- ✅ 前端SEO标签应用
- ✅ 完整的安装/卸载脚本
- ✅ API测试功能
- ✅ 实时预览和字符计数
- ✅ SEO质量评分系统
- ✅ 响应式设计界面
- ✅ 快捷键支持
- ✅ 错误处理和日志记录
### 开发计划
- [ ] 批量生成SEO内容
- [ ] 多语言支持
- [ ] SEO分析报告
- [ ] 自定义提示词
- [ ] 集成更多AI服务
## 🐛 故障排除
### 常见问题
**Q: 生成SEO内容失败怎么办**
A: 请检查:
1. API Key和API URL是否正确配置
2. 网络连接是否正常
3. 查看WordPress错误日志中的"AI SEO API Response"信息
4. 确认Dify API返回的数据格式
**Q: 如何查看调试信息?**
A: 插件会在WordPress错误日志中记录详细的调试信息可以通过以下方式查看
1. 启用WordPress调试在wp-config.php中添加 `define('WP_DEBUG_LOG', true);`
2. 查看日志文件wp-content/debug.log
3. 搜索以下关键词:
- "AI SEO Request" - 查看请求信息
- "AI SEO Raw Response" - 查看原始API响应
- "AI SEO Parsed Data" - 查看解析后的数据
- "AI SEO Success" - 查看成功的处理结果
- "AI SEO Failed" - 查看失败的详细原因
- "AI SEO Error" - 查看具体错误信息
**Q: API返回数据但插件显示失败**
A: 这通常是响应格式问题:
1. 检查API返回的JSON格式是否包含title、description、keywords字段
2. 确认数据结构符合预期格式
3. 查看错误日志了解具体的响应内容
**Q: AI生成时间过长导致超时**
A: 插件已优化超时设置支持长时间AI生成
1. AJAX请求超时120秒2分钟
2. API请求超时120秒2分钟
3. PHP执行时间180秒3分钟
4. 如果仍然超时可能需要联系服务器管理员调整PHP配置
5. 建议在生成过程中保持页面打开,不要刷新或关闭
3. 文章内容是否足够
4. API服务是否可用
**Q: 生成的内容质量不理想?**
A: 建议:
1. 确保文章内容丰富且相关
2. 手动调整生成的内容
3. 多次生成选择最佳结果
4. 结合人工优化
**Q: 前端SEO标签不显示**
A: 检查:
1. 主题是否支持wp_head钩子
2. 是否有其他SEO插件冲突
3. 缓存是否已清理
4. 查看页面源代码确认Open Graph标签是否正确输出
**Q: Open Graph标签与其他SEO插件冲突**
A: 本插件使用Open Graph标签格式og:title、og:description等避免了与WordPress默认meta标签的冲突。如果仍有冲突
1. 检查其他SEO插件是否也输出相同的Open Graph标签
2. 考虑禁用其他SEO插件的相关功能
3. 使用浏览器开发者工具检查重复标签
### 调试模式
在wp-config.php中添加以下代码启用调试
```php
define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true);
```
## 📞 技术支持
如果您在使用过程中遇到问题,请:
1. 查看本文档的故障排除部分
2. 检查WordPress错误日志
3. 联系技术支持团队
## 📄 许可证
本插件基于GNU通用公共许可证第3版GPL v3发布。
- **许可证类型**: GPL v3
- **项目仓库**: https://ckk.photo8.site/Photo8/wordpress-plugins
- **许可证文件**: 详见项目根目录的 `LICENSE` 文件
本程序是自由软件您可以根据自由软件基金会发布的GNU通用公共许可证第3版或根据您的选择任何更高版本的条款重新分发和/或修改它。
发布此程序是希望它有用但不提供任何保证甚至不提供适销性或特定用途适用性的暗示保证。有关更多详细信息请参阅GNU通用公共许可证。
---
**开发者**: SnowZ
**版本**: 1.0.7
**最后更新**: 2025-08-13
**兼容WordPress版本**: 5.0+