This is the chinese documentation for the Frigate project, built with VitePress.

📖 中文文档

This repository contains comprehensive documentation for Frigate, including:

• Installation Guides - Multi-platform deployment instructions
• Configuration Documentation - Detailed setup and tuning guides
• Integration Guides - Third-party service integrations
• API Reference - Complete API documentation
• Troubleshooting - Common issues and solutions

Documentation is organized by topic with clear navigation and search capabilities.

• Node.js 16+
• npm or yarn

Install dependencies:

npm install

Start the local development server with hot reload:

npm run docs:dev

Visit http://localhost:5173 to view the documentation.

Generate the static production build:

npm run docs:build

Preview the production build locally:

npm run docs:preview

• VitePress - Static site generator for documentation
• Vue 3 - Reactive UI components
• Vite - Modern build tool
• Shiki - Syntax highlighting
• Mermaid - Diagram rendering

• Frigate GitHub Repository
• Official Documentation
• Home Assistant Integration

Contributions are welcome! Follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/improvement)
3. Make your changes
4. Commit your changes (git commit -m 'Add improvements')
5. Push to your branch (git push origin feature/improvement)
6. Open a Pull Request

• Follow Markdown formatting conventions
• Use proper code block language tags
• Include YAML examples for configuration
• Add diagrams and examples where appropriate
• Maintain consistent documentation structure

This documentation is licensed under the MIT License. See LICENSE file for details.

Copyright © 2026 Frigate CN

For documentation issues, questions, or suggestions:

• CNB Issues
• QQ Group