mirror of
https://github.com/blakeblackshear/frigate.git
synced 2025-10-27 10:52:11 +01:00
757150dec1
* Updated documentation * docusaurus.config and sidebars converted to Typescript to allow for typings * Added type for sidebars.ts * Replaced integrations/api.md with automatically generated openAPI specification. Make sidebar collapsible to increase readability * Fix HTTP API links in the documentation * Added rust as language in the openapi sidebar * Make sure configuration/pwa is present * Fix API slug * Fix links * Revert sidebarCollapsible configuration * Make HTTP API sidebar collapsed by default. Added CSS for OpenAPI methods * Proper localhost server path * Proper localhost server path * No introduction page * Lint
106 lines
2.9 KiB
TypeScript
106 lines
2.9 KiB
TypeScript
import type { SidebarsConfig, } from '@docusaurus/plugin-content-docs';
|
|
import { PropSidebarItemLink } from '@docusaurus/plugin-content-docs';
|
|
import frigateHttpApiSidebar from './docs/integrations/api/sidebar';
|
|
|
|
const sidebars: SidebarsConfig = {
|
|
docs: {
|
|
Frigate: [
|
|
'frigate/index',
|
|
'frigate/hardware',
|
|
'frigate/installation',
|
|
'frigate/camera_setup',
|
|
'frigate/video_pipeline',
|
|
'frigate/glossary',
|
|
],
|
|
Guides: [
|
|
'guides/getting_started',
|
|
'guides/configuring_go2rtc',
|
|
'guides/ha_notifications',
|
|
'guides/ha_network_storage',
|
|
'guides/reverse_proxy',
|
|
],
|
|
Configuration: {
|
|
'Configuration Files': [
|
|
'configuration/index',
|
|
'configuration/reference',
|
|
{
|
|
type: 'link',
|
|
label: 'Go2RTC Configuration Reference',
|
|
href: 'https://github.com/AlexxIT/go2rtc/tree/v1.9.4#configuration',
|
|
} as PropSidebarItemLink,
|
|
],
|
|
Detectors: [
|
|
'configuration/object_detectors',
|
|
'configuration/audio_detectors',
|
|
],
|
|
'Semantic Search': [
|
|
'configuration/semantic_search',
|
|
'configuration/genai',
|
|
],
|
|
Cameras: [
|
|
'configuration/cameras',
|
|
'configuration/review',
|
|
'configuration/record',
|
|
'configuration/snapshots',
|
|
'configuration/motion_detection',
|
|
'configuration/birdseye',
|
|
'configuration/live',
|
|
'configuration/restream',
|
|
'configuration/autotracking',
|
|
'configuration/camera_specific',
|
|
],
|
|
Objects: [
|
|
'configuration/object_filters',
|
|
'configuration/masks',
|
|
'configuration/zones',
|
|
'configuration/objects',
|
|
'configuration/stationary_objects',
|
|
],
|
|
'Extra Configuration': [
|
|
'configuration/authentication',
|
|
'configuration/notifications',
|
|
'configuration/hardware_acceleration',
|
|
'configuration/ffmpeg_presets',
|
|
"configuration/pwa",
|
|
'configuration/tls',
|
|
'configuration/advanced',
|
|
],
|
|
},
|
|
Integrations: [
|
|
'integrations/plus',
|
|
'integrations/home-assistant',
|
|
// This is the HTTP API generated by OpenAPI
|
|
{
|
|
type: 'category',
|
|
label: 'HTTP API',
|
|
link: {
|
|
type: 'generated-index',
|
|
title: 'Frigate HTTP API',
|
|
description: 'HTTP API',
|
|
slug: '/integrations/api/frigate-http-api',
|
|
},
|
|
items: frigateHttpApiSidebar,
|
|
},
|
|
'integrations/mqtt',
|
|
'integrations/third_party_extensions',
|
|
],
|
|
'Frigate+': [
|
|
'plus/index',
|
|
'plus/first_model',
|
|
'plus/improving_model',
|
|
'plus/faq',
|
|
],
|
|
Troubleshooting: [
|
|
'troubleshooting/faqs',
|
|
'troubleshooting/recordings',
|
|
'troubleshooting/edgetpu',
|
|
],
|
|
Development: [
|
|
'development/contributing',
|
|
'development/contributing-boards',
|
|
],
|
|
},
|
|
};
|
|
|
|
export default sidebars;
|