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 installStart the local development server with hot reload:
npm run docs:devVisit http://localhost:5173 to view the documentation.
Generate the static production build:
npm run docs:buildPreview 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
Contributions are welcome! Follow these steps:
- Fork the repository
- Create a feature branch (
git checkout -b feature/improvement) - Make your changes
- Commit your changes (
git commit -m 'Add improvements') - Push to your branch (
git push origin feature/improvement) - 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: