这是 Frigate 项目的中文文档，采用 VitePress 构建。

📖 English

本仓库包含 Frigate 的完整文档，涵盖：

• 安装指南 - 多平台部署说明
• 配置文档 - 详细的设置和调优指南
• 集成指南 - 第三方服务集成
• API 参考 - 完整的 API 文档
• 故障排除 - 常见问题和解决方案

文档按主题组织，具有清晰的导航和搜索功能。

• Node.js 16+
• npm 或 yarn

安装项目依赖：

npm install

启动本地开发服务器（支持热重载）：

npm run docs:dev

访问 http://localhost:5173 查看文档。

生成静态生产版本：

npm run docs:build

本地预览生产版本：

npm run docs:preview

• VitePress - 文档网站生成工具
• Vue 3 - 反应式 UI 组件框架
• Vite - 现代化构建工具
• Shiki - 代码语法高亮
• Mermaid - 图表绘制工具

• Frigate GitHub 仓库
• 官方文档
• Home Assistant 集成

欢迎提交贡献！请按照以下步骤：

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/improvement)
3. 进行更改
4. 提交更改 (git commit -m 'Add improvements')
5. 推送到分支 (git push origin feature/improvement)
6. 打开 Pull Request

• 遵循 Markdown 格式约定
• 代码块使用正确的语言标记
• 配置示例使用 YAML 格式
• 在必要的地方添加图表和示例
• 保持文档结构一致

本文档采用 MIT 许可证。详见 LICENSE 文件。

版权所有 © 2026 Frigate CN

有关文档问题、问题或建议：

• CNB Issues
• QQ群