diff --git a/docs/blog/websitebeauty/MkDocs-AI-Hooks.md b/docs/blog/websitebeauty/MkDocs-AI-Hooks.md
index 0998239..0a3421b 100644
--- a/docs/blog/websitebeauty/MkDocs-AI-Hooks.md
+++ b/docs/blog/websitebeauty/MkDocs-AI-Hooks.md
@@ -7,9 +7,8 @@ status: new
# MkDocs AI Hooks
-仓库地址:https://github.com/Wcowin/mkdocs-ai-hooks
-在线预览:https://wcowin.work/mkdocs-ai-hooks/
-
+仓库地址:https://github.com/Wcowin/mkdocs-ai-hooks
+在线预览:https://wcowin.work/mkdocs-ai-hooks/
@@ -18,392 +17,523 @@ status: new
- 中文 | English
+ 中文 | English
🚀 **您的MkDocs文档首选智能摘要!**
这个项目利用MkDocs hooks,为您的技术文档和博客添加AI驱动的摘要生成和智能阅读统计功能。
-
-
-网站效果预览:https://wcowin.work/Mkdocs-Wcowin/blog/Mkdocs/mkfirst/
+
+
+
+🌐 **在线演示**: https://wcowin.work/mkdocs-ai-hooks/
+
+
+---
## ✨ 功能特性
-### AI智能摘要
-- **自动生成文章摘要**:使用DeepSeek API生成高质量的80-120字摘要
-- **多语言支持**:支持中文、英文等多种语言
-- **多API服务支持**:支持OpenAI、Claude等多种AI服务
-- **智能内容清理**:自动过滤YAML、HTML、代码块等格式内容
-- **备用摘要机制**:API失败时提供基于规则的智能摘要
-- **高效缓存系统**:避免重复API调用,7天智能过期
-- **灵活配置**:支持文件夹级别和页面级别的精确控制
+### 🤖 AI智能摘要
+- **多AI服务集成**: 支持DeepSeek、OpenAI、Claude、Gemini等主流AI服务
+- **自动摘要生成**: 生成高质量的80-120字智能摘要
+- **多语言支持**: 支持中文、英文、双语摘要生成
+- **智能内容清理**: 自动过滤YAML、HTML、代码块等格式内容
+- **备用摘要机制**: API失败时提供基于关键词的本地摘要
+- **智能缓存系统**: 7天智能过期,避免重复API调用
+- **灵活配置**: 支持文件夹级别和页面级别的精确控制
-### 智能阅读统计(可选)
-- **精准中文字符统计**:专门优化的中文内容识别
-- **智能代码检测**:识别多种编程语言和命令行代码
-- **阅读时间估算**:基于中文阅读习惯的400字/分钟计算
-- **美观信息展示**:使用MkDocs Material风格的信息框
+### 📊 智能阅读统计(可选)
+- **精准字符统计**: 专门优化的中英文内容识别
+- **智能代码检测**: 识别30+编程语言和命令行代码
+- **阅读时间估算**: 基于语言特性的智能计算(中文400字/分钟,英文200词/分钟)
+- **美观信息展示**: 使用MkDocs Material风格的信息框
-### 智能化特性
-- **自动语言识别**:支持30+编程语言和标记语言
-- **内容类型检测**:区分代码、配置、命令行等不同内容
-- **缓存优化**:LRU缓存提升性能
-- **错误处理**:完善的异常处理和日志记录
+### 🚀 智能化特性
+- **环境自适应**: 自动识别CI/本地环境,本地或者部署都可选启用/禁用
+- **自动语言识别**: 支持30+编程语言和标记语言
+- **内容类型检测**: 区分代码、配置、命令行等不同内容
+- **LRU缓存优化**: 提升处理性能(Todo)
+- **完善错误处理**: 异常处理和日志记录(Todo)
-## 📦 安装
+---
-### 方法1
-直接下载(推荐)
-在releases页面下载,解压后将以下文件放入您的MkDocs项目的docs/overrides/hooks中:
-https://github.com/Wcowin/mkdocs-ai-hooks/releases
+## 📦 快速安装
+### 方法1: 直接下载(推荐)
-或者下载上方hooks目录下的两个Python文件:
-
-- `ai_summary.py`:AI摘要生成器
-
-- `reading_time.py`:阅读时间统计器
+**步骤1**: 下载文件
+- 从 [Releases页面](https://github.com/Wcowin/mkdocs-ai-hooks/releases) 下载最新版本
+- 或直接下载 `ai_summary.py`文件
+**步骤2**: 创建目录并放置文件
```bash
-# 放置到您的项目目录
+# 在您的MkDocs项目根目录下执行
mkdir -p docs/overrides/hooks/
mv ai_summary.py docs/overrides/hooks/
-mv reading_time.py docs/overrides/hooks/
```
-放置的位置如下:
-
-在 `mkdocs.yml` 中theme下添加custom_dir:
+**步骤3**: 配置MkDocs主题以及覆写路径
```yaml
-# 可选:Material主题配置
+# 在 mkdocs.yml 中添加
theme:
name: material
- custom_dir: docs/overrides #一定要有!一定要有!
+ custom_dir: docs/overrides # 必需配置!!!
features:
- content.code.copy
- content.code.select
```
-### 方法2
-
-使用Git克隆
+### 方法2: Git克隆
```bash
-git clone https://github.com/Wcowin/mkdocs-ai-hooks.git
+git clone https://github.com/Wcowin/mkdocs-ai-hooks.git
cd mkdocs-ai-hooks
pip install -r requirements.txt
```
### 依赖安装
```bash
-pip install requirements.txt
+pip install -r requirements.txt
```
+---
+
## 🚀 快速开始
-### 1. 配置MkDocs
-先执行一次`mkdocs build`,生成缓存文件
-```bash
-mkdocs build
-```
-在 `mkdocs.yml` 中添加hooks,theme下添加custom_dir:
+### 1. 基础配置
+
+**步骤1**: 配置hooks
+ai_summary.py务必放到docs/overrides/hooks目录下,然后:
```yaml
+# 在 mkdocs.yml 中添加
hooks:
- - docs/overrides/hooks/ai_summary.py # 添加AI摘要hook
- - docs/overrides/hooks/reading_time.py # 添加统计阅读时间hook
-
-# 可选:Material主题配置
-theme:
- name: material
- custom_dir: docs/overrides #一定要有!!
- features:
- - content.code.copy
- - content.code.select
+ - docs/overrides/hooks/ai_summary.py # AI摘要hook
```
-
-### 2. 在ai_summary.py中配置需要AI摘要的目录
-```python
-# 📂 可自定义的文件夹配置
-self.enabled_folders = [
- 'blog/', # blog文件夹
- 'develop/', # develop文件夹
- # 在这里添加您想要启用AI摘要的文件夹
-]
-
-# 📋 排除的文件和文件夹
-self.exclude_patterns = [
- 'waline.md', 'link.md', '404.md', 'tag.md', 'tags.md',
- '/about/', '/search/', '/sitemap', 'index.md', # 根目录index.md
-]
-
-# 📋 排除的特定文件
-self.exclude_files = [
- 'blog/index.md',
- 'blog/indexblog.md',
- 'docs/index.md',
- 'develop/index.md',
-]
-```
-
-### 3. 在ai_summary.py中设置DeepSeek API(默认是OpenAI)
-```python
-# 在ai_summary.py中修改API配置
-'deepseek': {
- 'url': 'https://api.deepseek.com/v1/chat/completions',
- 'model': 'deepseek-chat',
- 'api_key': os.getenv('DEEPSEEK_API_KEY', 'your-azure-api-key'),
- 'max_tokens': 150,
- 'temperature': 0.3
-},
-```
-
-### 4. 运行MkDocs
-第一次运行时,可能需要等待一段时间,因为系统会自动生成摘要。后续运行时,系统会使用缓存数据,加快生成速度。
+**步骤2**: 本地配置
+根目录下创建 `.env` 文件存放密钥(记得添加到 `.gitignore`):
```bash
-#依次运行命令
-mkdocs build
-mkdocs serve
+# .env 文件内容
+DEEPSEEK_API_KEY=your_deepseek_api_key_here
+OPENAI_API_KEY=your_openai_api_key_here
```
-终端输出如下:
-
+
+```bash
+#.gitignore 文件内容
+# 环境变量文件(敏感信息)
+.env
+.env.local
+.env.*.local
+*.key
+
+# MkDocs 构建输出目录
+site/
+
+# AI 摘要缓存目录(项目根目录)- 需要被提交
+!.ai_cache/
+```
+
+到这里检查下目录树状图:
+```
+$ tree -a
+文件名
+├── .github
+│ ├── .DS_Store
+│ └── workflows
+│ └── ci.yml
+├── docs
+│ └── index.md
+| └── overrides
+│ └── hooks
+│ └── ai_summary.py
+├── .env
+├──.gitignore
+├── README.md
+└── mkdocs.yml
+```
+
+### 2. 配置AI服务
+
+**选择AI服务提供商**:
+- 🌟 **DeepSeek**(推荐):性价比高,中文表现优秀
+- 🔥 **OpenAI**:功能强大,广泛支持
+- ⚡ **Claude**:逻辑清晰,文本理解佳
+- 🧠 **Gemini**:Google出品,多语言支持
+
+**获取API密钥**:
+- [DeepSeek](https://platform.deepseek.com/usage) - 注册获取API密钥
+- [ChatAnywhere](https://github.com/chatanywhere/GPT_API_free) - 免费OpenAI额度
+
+**获取的密钥存放于上一步创建的`.env` 文件中!!!**
+
+### 3. 设置参数
+
+在 `ai_summary.py` 中配置需要AI摘要的目录:
+```python
+# 📂 启用AI摘要的文件夹
+self.enabled_folders = [
+ 'blog/', # 博客文章
+ # 添加更多文件夹...
+]
+```
+
+### 4. 本地运行和测试
+
+```bash
+mkdocs serve # 本地预览
+```
+### 5. 部署配置
+
+```yaml
+#ci.yml
+name: ci
+on:
+ push:
+ branches:
+ - master
+ - main
+ # 禁止从 fork 仓库访问 secrets
+ pull_request:
+ types: [closed]
+ branches: [main, master]
+permissions:
+ contents: write
+jobs:
+ deploy:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ sparse-checkout: |
+ docs
+ includes
+ requirements.txt
+ .ai_cache
+ - uses: actions/setup-python@v4
+ with:
+ python-version: 3.x
+ - name: Set cache ID
+ run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+ - uses: actions/cache@v3
+ with:
+ key: mkdocs-material-${{ github.run_number }}
+ path: .cache
+ restore-keys: |
+ mkdocs-material-
+ - run: pip install mkdocs-git-revision-date-localized-plugin
+ - run: pip install mkdocs-git-authors-plugin
+ - run: pip install mkdocs-git-committers-plugin-2
+ - run: pip install markdown-callouts
+ - run: pip install mkdocs-rss-plugin
+ - run: pip install requests>=2.25.0
+ - run: pip install python-dateutil>=2.8.0
+ - run: pip install cachetools>=4.2.0
+ - run: pip install python-dotenv>=0.19.0
+ - run: pip install pymdown-extensions
+ - run: pip install mkdocs-material
+ - run: pip install --upgrade --force-reinstall mkdocs-material
+ - name: Deploy with AI Summary
+ env:
+ # AI摘要开关控制
+ AI_SUMMARY_CI_ENABLED: 'true' # CI部署环境启用AI摘要 (true=在CI中为文章生成AI摘要)
+ AI_SUMMARY_CI_ONLY_CACHE: 'true' # CI部署不生成新摘要 (true=使用本地部署过的摘要缓存,不再重复调用API)
+ AI_SUMMARY_CI_FALLBACK: 'true' # CI部署启用备用摘要 (true=API失败时生成离线基础摘要)
+ # AI_SUMMARY_LOCAL_ENABLED: 'false' # 本地部署环境禁用AI摘要 (true=本地开发时也生成摘要)(不需要管这条)
+ # AI_SUMMARY_CACHE_ENABLED: 'true' # 本地启用缓存功能 (true=缓存摘要避免重复生成)(不需要管这条)
+ # API密钥配置
+ DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
+ OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+ run: mkdocs gh-deploy --force
+
+ # 自动提交新生成的AI缓存文件
+ - name: Auto-commit AI cache (if any new files)
+ run: |
+ if [ -d ".ai_cache" ] && [ "$(ls -A .ai_cache 2>/dev/null)" ]; then
+ git config --local user.email "action@github.com"
+ git config --local user.name "GitHub Action"
+ git add .ai_cache/
+ if ! git diff --cached --quiet; then
+ git commit -m "🤖 Auto-update AI summary cache [skip ci]"
+ git push
+ echo "✅ 自动提交了新的 AI 缓存文件"
+ else
+ echo "ℹ️ 没有新的缓存文件需要提交"
+ fi
+ else
+ echo "ℹ️ 没有找到缓存目录或缓存为空"
+ fi
+```
+
+```python
+# ai_summary.py 中配置
+# AI摘要本地环境配置
+self.ci_config = {
+ # CI部署环境开关 (不用管,只在ci.yml中设置有效)
+ 'enabled_in_ci': os.getenv('AI_SUMMARY_CI_ENABLED', 'true').lower() == 'true',
+
+ # 本地部署环境开关 (true=本地开发时启用AI摘要)
+ 'enabled_in_local': os.getenv('AI_SUMMARY_LOCAL_ENABLED', 'true').lower() == 'true',
+
+ # CI部署仅缓存模式(不用管,只在ci.yml中设置有效)
+ 'ci_only_cache': os.getenv('AI_SUMMARY_CI_ONLY_CACHE', 'false').lower() == 'true',
+
+ # 本地部署缓存功能开关 (true=启用缓存避免重复生成, false=总是生成新摘要)
+ 'cache_enabled': os.getenv('AI_SUMMARY_CACHE_ENABLED', 'true').lower() == 'true',
+
+ # CI部署备用摘要开关 (不用管,只在ci.yml中设置有效)
+ 'ci_fallback_enabled': os.getenv('AI_SUMMARY_CI_FALLBACK', 'true').lower() == 'true',
+}
+```
+
+**几种运行模式**:
+1. **完全禁用**: 本地和CI部署都不运行摘要生成
+2. **仅CI部署启用**: 本地禁用,CI部署生成新摘要
+3. **缓存模式**:本地已经生成过摘要,CI部署使用缓存(**推荐。上方配置项中已默认CI部署的缓存模式,可自行搭配选择**)
+4. **完全启用**: 本地和CI部署都运行(API消耗会更多)
+
+### 6. GitHub Secrets配置
+
+**步骤1**: 设置Repository Secrets
+1. 进入GitHub仓库 → **Settings** → **Secrets and variables** → **Actions**
+2. 点击 **New repository secret** 添加:
+```
+DEEPSEEK_API_KEY=your_deepseek_api_key_here
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+---
+
+然后部署到GitHub Pages或其他平台即可。
+
+**有报错可以去问ChatGPT或者在Issues中提问。**
## 📖 使用指南
-### AI摘要配置
+### AI摘要控制
-#### 文件夹级别控制
-```python
-# 启用特定文件夹
-configure_ai_summary(['blog/', 'docs/', 'tutorials/'])
-
-# 全局启用(除排除项)
-configure_ai_summary([''])
-```
-
-#### 页面级别控制(推荐)
-在Markdown文件的YAML front matter中:
+#### 方法1: 页面级控制(推荐)
+在Markdown文件最上面的yaml meta中:
+**启用AI摘要**:
```yaml
---
title: 文章标题
ai_summary: true # 启用AI摘要
---
```
-
+
+**禁用AI摘要**:
```yaml
---
title: 文章标题
ai_summary: false # 禁用AI摘要
-description: 手动摘要 # 可选
+description: 自定义摘要内容 # 可选手动摘要
---
```
-### 阅读时间配置
-
-#### 排除特定页面
+#### 方法2: 文件夹级控制
```python
-# 在页面的YAML front matter中
----
-title: 页面标题
-hide_reading_time: true # 隐藏阅读时间
----
+# 在 ai_summary.py 中配置
+# 📂 可自定义的文件夹配置
+self.enabled_folders = [
+ 'blog/', # blog文件夹
+ 'index.md',
+ # 'develop/', # develop文件夹
+ # 'posts/', # posts文件夹
+ # 'trip/', # trip文件夹
+ # 'about/', # about文件夹
+]
+
+# 📋 Excluded files and folders
+self.exclude_patterns = [
+ '404.md', 'tag.md', 'tags.md',
+]
+
+# 📋 Excluded specific files
+self.exclude_files = [
+ 'blog/index.md',
+]
```
+
+---
+
## 🎨 显示效果
-### AI摘要显示
-```markdown
-!!! info "🤖 AI智能摘要"
- 本文详细介绍了MkDocs hooks的开发和使用方法,涵盖AI摘要生成、阅读时间统计等功能实现。通过DeepSeek API集成和智能缓存机制,为技术文档提供自动化的内容增强服务。
-
-# 您的文章标题
-文章内容...
-```
-
-### 阅读信息显示
-```markdown
-!!! info "📖 阅读信息"
- 阅读时间:**3** 分钟 | 中文字符:**1247** | 有效代码行数:**45**
-
-# 您的文章标题
-文章内容...
-```
-
-**实际效果:**
-
-
-### API花费
-一次大约0.03-0.05元(中大型文档)
-可以说相当经济实惠了!
-
-#### 免费openai额度获取
-
-推荐使用:[chatanywhere](https://github.com/chatanywhere/GPT_API_free?tab=readme-ov-file#%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8 )
-
-申请好后得到sk-开头的密钥,在ai_summary.py的多AI服务配置部分替换为以下内容:
-
-```python
-'openai': {
- 'url': 'https://api.chatanywhere.tech/v1/chat/completions',
- 'model': 'gpt-3.5-turbo', # 或 'gpt-4', 'gpt-4-turbo'
- 'api_key': os.getenv('OPENAI_API_KEY', 'your_openai_api_key'),
- 'max_tokens': 150,
- 'temperature': 0.3
-},
-```
-
-```python
-# 默认使用的AI服务
-self.default_service = 'openai'
-```
+### AI摘要显示
+**实际效果预览**:
+
-但是我这里也推荐使用[DeepSeek](https://platform.deepseek.com/usage) API,额度充足且性能优秀。
+### 💰 成本说明
+- **单次费用**: 约0.03-0.05元(中大型文档)
+- **月度预估**: 普通博客约1-5元
+- **免费额度**: 多数AI服务商提供新用户免费额度
+
+---
## ⚙️ 高级配置
-### 自定义API服务
+### 自定义AI服务
```python
-# 支持其他AI服务
-self.api_config = {
- 'url': 'https://your-api-endpoint.com/v1/chat/completions',
- 'model': 'your-model',
- 'headers': {
- 'Content-Type': 'application/json',
- 'Authorization': 'Bearer YOUR_API_KEY'
+# 添加新的AI服务
+self.ai_services = {
+ 'your_service': {
+ 'url': 'https://api.yourservice.com/v1/chat/completions',
+ 'model': 'your-model',
+ 'api_key': os.getenv('YOUR_API_KEY'),
+ 'max_tokens': 150,
+ 'temperature': 0.3
}
}
+
+# 默认使用的AI服务
+self.default_service = 'your_service'
+
+# 服务优先级(按顺序尝试)
+self.service_fallback_order = ['openai', 'deepseek', 'claude', 'gemini'] # 按顺序尝试
```
+
+
### 自定义提示词
```python
-# 修改AI摘要的提示词
def generate_ai_summary(self, content, page_title=""):
- prompt = f"""您的自定义提示词...
+ prompt = f"""请为以下技术文档生成一个简洁的中文摘要(80-120字):
文章标题:{page_title}
文章内容:{content[:2500]}
+
+ 要求:
+ 1. 突出核心技术要点
+ 2. 使用简洁专业的语言
+ 3. 长度控制在80-120字
"""
```
### 缓存配置
```python
-# 修改缓存过期时间(天数)
+# 修改缓存过期时间
cache_time = datetime.fromisoformat(cache_data.get('timestamp', '1970-01-01'))
if (datetime.now() - cache_time).days < 30: # 改为30天
return cache_data
```
-注意注意注意!!!
-切换api服务后,要删除site/.ai_cache这个缓存文件,才可以重新生成摘要!!!**(这个问题已经解决了,切换api服务后,会自动删除缓存文件,无需手动删除)**
-
-
-### 自定义摘要格式
-```python
-def format_summary(self, summary, ai_service):
- """自定义摘要显示格式"""
- return f'''!!! note "✨ 自定义摘要"
- {summary}
-
- *由 {ai_service} 生成*
-'''
-```
## 🌍 多语言支持
-### 英文内容优化(Todo)
+### 语言配置
```python
-# 阅读时间计算(英文:200词/分钟)
-def calculate_english_reading_time(word_count):
- return max(1, round(word_count / 200))
+# 在 ai_summary.py 中设置
+self.summary_language = 'zh' # 中文摘要
+# self.summary_language = 'en' # 英文摘要
+# self.summary_language = 'both' # 双语摘要
```
-### 其他语言扩展(Todo)
-```python
-# 支持日文、韩文等
-JAPANESE_CHARS_PATTERN = re.compile(r'[\u3040-\u309F\u30A0-\u30FF]')
-KOREAN_CHARS_PATTERN = re.compile(r'[\uAC00-\uD7AF]')
-```
+### 支持的语言
+- **完全支持**: 中文、English
+- **部分支持**: 日本語です、한글、Français、Deutsch
+
+---
## 📊 性能优化
-- **LRU缓存**:函数级别缓存提升性能
-- **正则预编译**:提高文本处理速度
-- **智能过滤**:减少不必要的API调用
-- **异步支持**:可扩展为异步处理(TODO)
+### 已实现优化
+- **LRU缓存**: 函数级别缓存提升性能
+- **正则预编译**: 提高文本处理速度
+- **智能过滤**: 减少不必要的API调用
+- **内容哈希**: 基于内容变化的智能缓存
+
+### 性能建议
+- 使用 `ci_only_cache: true` 在CI环境中仅使用缓存
+- 合理设置 `enabled_folders` 避免处理不必要的文件
+- 定期清理过期缓存文件
+
+---
## 🤝 贡献指南
-我们欢迎各种形式的贡献!
-
+### 如何贡献
1. **Fork** 这个仓库
-2. 创建您的特性分支
-3. 提交您的更改
-4. 推送到分支
-5. 打开一个 **Pull Request**
+2. 创建特性分支
+3. 提交更改
+4. 推送分支
+5. 创建 **Pull Request**
-### 开发环境设置
+### 开发环境
```bash
-# 克隆仓库
git clone https://github.com/Wcowin/mkdocs-ai-hooks.git
cd mkdocs-ai-hooks
-
-# 安装依赖
pip install -r requirements.txt
-
```
+---
+
## 📝 更新日志
-### v1.0.0 (2025-06-03)
-- ✨ 初始发布
-- 🤖 AI智能摘要功能
-- 📖 阅读时间统计功能
-- 💾 智能缓存系统
-- 🎯 灵活配置选项
+### [v1.3.0] (2025-06-04) - 最新版本
-### 计划功能
-- [x] 多AI服务支持(OpenAI、Claude等)
-- [x] 自动选择最佳API
-- [ ] API密钥安全处理(重要)
-- [ ] 批量处理模式
-- [ ] 统计数据导出
-- [ ] Web界面配置
+#### 核心改进
+
+- **统一缓存架构**
+- **缓存路径统一为项目根目录 .ai_cache**
+- **本地和 CI 环境使用相同缓存策略**
+- **增强 CI/CD 支持**,**支持 CI 仅缓存模式,大幅减少部署时间**
+- **智能识别 15+ 部署平台(GitHub Actions、GitLab CI 等)**
+- **可配置备用摘要机制**
+
+### [v1.2.0] (2025-06-03)
+
+#### ✨ 主要新功能
+- **多AI服务支持**: 集成DeepSeek、OpenAI、Gemini、Claude
+- **环境自适应**: 自动识别CI/本地环境
+- **智能缓存系统**: 内容哈希缓存,7天自动过期
+- **安全配置**: GitHub Secrets集成,API密钥安全管理
+
+#### 🔧 技术改进
+- **统一API接口**: 自适配不同AI服务格式
+- **错误处理增强**: 完善的异常处理机制
+- **性能优化**: LRU缓存和正则预编译
+
+### [v1.0.0] (2025-06-01) - 初始版本
+- 🤖 **AI智能摘要功能**
+- 📖 **阅读时间统计功能**
+- 💾 **基础缓存系统**
+- 🎯 **基本配置选项**
+
+---
## 🐛 问题反馈
-如果您遇到任何问题,请在 [Issues](https://github.com/Wcowin/mkdocs-ai-hooks/issues) 中提交。
+遇到问题?请在 [Issues](https://github.com/Wcowin/mkdocs-ai-hooks/issues) 中反馈。
-提交问题时请包含:
-- MkDocs版本
-- Python版本
-- 错误信息
-- 复现步骤
+**反馈时请包含**:
+- MkDocs版本
+- Python版本
+- 完整错误信息
+- 复现步骤
+- 配置文件(去除敏感信息)
+
+---
## 📄 许可证
-本项目采用 [MIT License](LICENSE) 开源协议。
+本项目采用 [MIT License](https://github.com/Wcowin/mkdocs-ai-hooks/blob/main/LICENSE) 开源协议。
+
+---
## 🙏 致谢
-- [MkDocs](https://www.mkdocs.org/) - 静态站点生成器
-- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) - 优秀的主题
-- [DeepSeek](https://deepseek.com/) - AI API服务
+感谢以下项目和服务:
+
+- [MkDocs](https://www.mkdocs.org/) - 优秀的静态站点生成器
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) - 精美的主题
+- [DeepSeek](https://deepseek.com/) - 高性价比的AI API服务
- 所有贡献者和使用者
+---
+
# Connect with me
diff --git a/docs/overrides/hooks/ai_summary.py b/docs/overrides/hooks/ai_summary.py
index add6195..412e331 100644
--- a/docs/overrides/hooks/ai_summary.py
+++ b/docs/overrides/hooks/ai_summary.py
@@ -20,19 +20,19 @@ class AISummaryGenerator:
# 🚀 CI 环境配置 - 默认只在 CI 环境中启用
# AI摘要环境配置
self.ci_config = {
- # CI部署环境开关 (true=CI中启用AI摘要生成)
+ # CI部署环境开关 (不用管,只在ci.yml中设置有效)
'enabled_in_ci': os.getenv('AI_SUMMARY_CI_ENABLED', 'true').lower() == 'true',
# 本地部署环境开关 (true=本地开发时启用AI摘要)
'enabled_in_local': os.getenv('AI_SUMMARY_LOCAL_ENABLED', 'false').lower() == 'true',
- # CI部署仅缓存模式 (true=仅使用缓存不调用API, false=允许生成新摘要)
+ # CI部署仅缓存模式(不用管,只在ci.yml中设置有效)
'ci_only_cache': os.getenv('AI_SUMMARY_CI_ONLY_CACHE', 'false').lower() == 'true',
# 本地部署缓存功能开关 (true=启用缓存避免重复生成, false=总是生成新摘要)
'cache_enabled': os.getenv('AI_SUMMARY_CACHE_ENABLED', 'true').lower() == 'true',
- # CI部署备用摘要开关 (true=API失败时生成基础摘要, false=失败时不显示摘要)
+ # CI部署备用摘要开关 (不用管,只在ci.yml中设置有效)
'ci_fallback_enabled': os.getenv('AI_SUMMARY_CI_FALLBACK', 'true').lower() == 'true',
}