mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-02-15 15:45:27 +03:00
docusaurus.config and sidebars converted to Typescript to allow for typings
This commit is contained in:
Rui Alves
parent
e228e29158
commit
c4e30ca884
@ -1,102 +0,0 @@
|
|||||||
const path = require("path");
|
|
||||||
|
|
||||||
module.exports = {
|
|
||||||
title: "Frigate",
|
|
||||||
tagline: "NVR With Realtime Object Detection for IP Cameras",
|
|
||||||
url: "https://docs.frigate.video",
|
|
||||||
baseUrl: "/",
|
|
||||||
onBrokenLinks: "throw",
|
|
||||||
onBrokenMarkdownLinks: "warn",
|
|
||||||
favicon: "img/favicon.ico",
|
|
||||||
organizationName: "blakeblackshear",
|
|
||||||
projectName: "frigate",
|
|
||||||
themes: ["@docusaurus/theme-mermaid"],
|
|
||||||
markdown: {
|
|
||||||
mermaid: true,
|
|
||||||
},
|
|
||||||
themeConfig: {
|
|
||||||
algolia: {
|
|
||||||
appId: "WIURGBNBPY",
|
|
||||||
apiKey: "d02cc0a6a61178b25da550212925226b",
|
|
||||||
indexName: "frigate",
|
|
||||||
},
|
|
||||||
docs: {
|
|
||||||
sidebar: {
|
|
||||||
hideable: true,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
prism: {
|
|
||||||
additionalLanguages: ["bash", "json"],
|
|
||||||
},
|
|
||||||
navbar: {
|
|
||||||
title: "Frigate",
|
|
||||||
logo: {
|
|
||||||
alt: "Frigate",
|
|
||||||
src: "img/logo.svg",
|
|
||||||
srcDark: "img/logo-dark.svg",
|
|
||||||
},
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
to: "/",
|
|
||||||
activeBasePath: "docs",
|
|
||||||
label: "Docs",
|
|
||||||
position: "left",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: "https://frigate.video",
|
|
||||||
label: "Website",
|
|
||||||
position: "right",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: "http://demo.frigate.video",
|
|
||||||
label: "Demo",
|
|
||||||
position: "right",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
href: "https://github.com/blakeblackshear/frigate",
|
|
||||||
label: "GitHub",
|
|
||||||
position: "right",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
footer: {
|
|
||||||
style: "dark",
|
|
||||||
links: [
|
|
||||||
{
|
|
||||||
title: "Community",
|
|
||||||
items: [
|
|
||||||
{
|
|
||||||
label: "GitHub",
|
|
||||||
href: "https://github.com/blakeblackshear/frigate",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: "Discussions",
|
|
||||||
href: "https://github.com/blakeblackshear/frigate/discussions",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
copyright: `Copyright © ${new Date().getFullYear()} Blake Blackshear`,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
plugins: [path.resolve(__dirname, "plugins", "raw-loader")],
|
|
||||||
presets: [
|
|
||||||
[
|
|
||||||
"@docusaurus/preset-classic",
|
|
||||||
{
|
|
||||||
docs: {
|
|
||||||
routeBasePath: "/",
|
|
||||||
sidebarPath: require.resolve("./sidebars.js"),
|
|
||||||
// Please change this to your repo.
|
|
||||||
editUrl:
|
|
||||||
"https://github.com/blakeblackshear/frigate/edit/master/docs/",
|
|
||||||
sidebarCollapsible: false,
|
|
||||||
},
|
|
||||||
|
|
||||||
theme: {
|
|
||||||
customCss: require.resolve("./src/css/custom.css"),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
],
|
|
||||||
],
|
|
||||||
};
|
|
||||||
102
docs/docusaurus.config.ts
Normal file
102
docs/docusaurus.config.ts
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
import type * as Preset from '@docusaurus/preset-classic';
|
||||||
|
import * as path from 'node:path';
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
title: 'Frigate',
|
||||||
|
tagline: 'NVR With Realtime Object Detection for IP Cameras',
|
||||||
|
url: 'https://docs.frigate.video',
|
||||||
|
baseUrl: '/',
|
||||||
|
onBrokenLinks: 'throw',
|
||||||
|
onBrokenMarkdownLinks: 'warn',
|
||||||
|
favicon: 'img/favicon.ico',
|
||||||
|
organizationName: 'blakeblackshear',
|
||||||
|
projectName: 'frigate',
|
||||||
|
themes: ['@docusaurus/theme-mermaid'],
|
||||||
|
markdown: {
|
||||||
|
mermaid: true,
|
||||||
|
},
|
||||||
|
themeConfig: {
|
||||||
|
algolia: {
|
||||||
|
appId: 'WIURGBNBPY',
|
||||||
|
apiKey: 'd02cc0a6a61178b25da550212925226b',
|
||||||
|
indexName: 'frigate',
|
||||||
|
},
|
||||||
|
docs: {
|
||||||
|
sidebar: {
|
||||||
|
hideable: true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
prism: {
|
||||||
|
additionalLanguages: ['bash', 'json'],
|
||||||
|
},
|
||||||
|
navbar: {
|
||||||
|
title: 'Frigate',
|
||||||
|
logo: {
|
||||||
|
alt: 'Frigate',
|
||||||
|
src: 'img/logo.svg',
|
||||||
|
srcDark: 'img/logo-dark.svg',
|
||||||
|
},
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
to: '/',
|
||||||
|
activeBasePath: 'docs',
|
||||||
|
label: 'Docs',
|
||||||
|
position: 'left',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: 'https://frigate.video',
|
||||||
|
label: 'Website',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: 'http://demo.frigate.video',
|
||||||
|
label: 'Demo',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: 'https://github.com/blakeblackshear/frigate',
|
||||||
|
label: 'GitHub',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
style: 'dark',
|
||||||
|
links: [
|
||||||
|
{
|
||||||
|
title: 'Community',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'GitHub',
|
||||||
|
href: 'https://github.com/blakeblackshear/frigate',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Discussions',
|
||||||
|
href: 'https://github.com/blakeblackshear/frigate/discussions',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
copyright: `Copyright © ${new Date().getFullYear()} Blake Blackshear`,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
plugins: [path.resolve(__dirname, 'plugins', 'raw-loader')],
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
'@docusaurus/preset-classic',
|
||||||
|
{
|
||||||
|
docs: {
|
||||||
|
routeBasePath: '/',
|
||||||
|
sidebarPath: require.resolve('./sidebars.js'),
|
||||||
|
// Please change this to your repo.
|
||||||
|
editUrl: 'https://github.com/blakeblackshear/frigate/edit/master/docs/',
|
||||||
|
sidebarCollapsible: false,
|
||||||
|
},
|
||||||
|
|
||||||
|
theme: {
|
||||||
|
customCss: require.resolve('./src/css/custom.css'),
|
||||||
|
},
|
||||||
|
} satisfies Preset.Options,
|
||||||
|
],
|
||||||
|
],
|
||||||
|
};
|
||||||
@ -1,87 +0,0 @@
|
|||||||
module.exports = {
|
|
||||||
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",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
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/tls",
|
|
||||||
"configuration/advanced",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
Integrations: [
|
|
||||||
"integrations/plus",
|
|
||||||
"integrations/home-assistant",
|
|
||||||
"integrations/api",
|
|
||||||
"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",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
};
|
|
||||||
87
docs/sidebars.ts
Normal file
87
docs/sidebars.ts
Normal file
@ -0,0 +1,87 @@
|
|||||||
|
module.exports = {
|
||||||
|
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',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
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/tls',
|
||||||
|
'configuration/advanced',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
Integrations: [
|
||||||
|
'integrations/plus',
|
||||||
|
'integrations/home-assistant',
|
||||||
|
'integrations/api',
|
||||||
|
'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',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
Loading…
Reference in New Issue
Block a user