AI知识中心
一个涵盖人工智能概念、模式和工具的集中学习资源,从基础知识到企业架构。建于 MkDocs材料 并部署到GitHub Pages。
Live网站:
涵盖的主题
- 人工智能基础、基础模型和提示技术
- RAG和知识系统(嵌入、分块、向量数据库、GraphRAG、评估)
- AI代理和代理模式
- 人工智能开发工具(GitHub Copilot、Claude Code、MCP)
- 人工智能系统的企业和设计模式
- 负责任的人工智能和安全
本地开发
选项1:Docker Compose(推荐使用——不需要Python)
git clone https://github.com/nitin27may/ai-resources.git
cd ai-resources
docker-compose up网站可在 http://localhost:8000 实时重新加载。
停止:
docker-compose down选项2:VS代码开发容器
- 克隆仓库并在VS代码中打开:
git clone https://github.com/nitin27may/ai-resources.git
code ai-resources- 出现提示时,单击 在容器中重新打开 (或使用命令面板:
Dev Containers: Reopen in Container) - 容器会自动构建,安装依赖项,并在端口8000上启动开发服务器
开发容器包括Python 3.12、所有MkDocs插件、用于PDF导出的WeasyPrint以及用于Markdown和Mermaid的预配置VS Code扩展。
选项3:直接使用Python
git clone https://github.com/nitin27may/ai-resources.git
cd ai-resources
pip install -r requirements.txt
mkdocs serve --dev-addr=0.0.0.0:8000 --livereloadPDF导出(WeasyPrint)需要系统库。如果你不在Linux上,请使用Docker。
添加文档
- 在中创建Markdown文件
docs/在相应章节下 - 将其添加到
nav:部分mkdocs.yml--文件不是自动发现的 - 开发服务器会自动重新加载;无需重新启动
构建
mkdocs build
# Static output in ./site/要在不构建的情况下验证配置,请执行以下操作:
mkdocs config部署
推到 main 触发GitHub操作工作流(.github/workflows/deploy.yml),它会自动构建并部署到GitHub Pages。PR只运行构建检查。
故障排除
| 问题 | 修复 |
|---|---|
| 端口8000正在使用中 | 停止其他服务,或在中更改端口 devcontainer.json |
| 开发容器无法启动 | 确保Docker正在运行;尝试 Dev Containers: Rebuild Container |
| 美人鱼图未渲染 | 验证 pymdownx.superfences 配置在 mkdocs.yml |
| PDF导出失败 | 使用Docker(WeasyPrint需要macOS/Windows上不可用的系统库) |
git-revision-date errors | 确保仓库有git历史记录(git fetch --unshallow 浅层克隆) |
贡献
- 分叉存储库
- 创建分支:
git checkout -b docs/your-topic - 根据文档标准进行更改
CLAUDE.md - 提交pull请求
main
