BIG docs refactoring

2026-02-06 20:43:50 +03:00
parent 5bf5327a45
commit d01b99d105
67 changed files with 2104 additions and 1916 deletions
@@ -0,0 +1,147 @@
+import {defineConfig} from 'vitepress';
+
+export default defineConfig({
+    title: 'go2rtc',
+    themeConfig: {
+        nav: [
+            {text: 'Home', link: '/'},
+        ],
+        sidebar: [
+            {
+                items: [
+                    {text: 'Installation', link: '/#installation'},
+                    {text: 'Configuration', link: '/#configuration'},
+                    {text: 'Security', link: '/#security'},
+                ],
+            },
+            {
+                text: 'Features',
+                items: [
+                    {text: 'Streaming input', link: '/#streaming-input'},
+                    {text: 'Streaming output', link: '/#streaming-output'},
+                    {text: 'Streaming ingest', link: '/#streaming-ingest'},
+                    {text: 'Two-way audio', link: '/#two-way-audio'},
+                    {text: 'Stream to camera', link: '/#stream-to-camera'},
+                    {text: 'Publish stream', link: '/#publish-stream'},
+                    {text: 'Preload stream', link: '/#preload-stream'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Codecs',
+                items: [
+                    {text: 'Codecs filters', link: '/#codecs-filters'},
+                    {text: 'Codecs madness', link: '/#codecs-madness'},
+                    {text: 'Built-in transcoding', link: '/#built-in-transcoding'},
+                    {text: 'Codecs negotiation', link: '/#codecs-negotiation'},
+                ],
+                collapsed: true,
+            },
+            {
+                text: 'Other',
+                items: [
+                    {text: 'Projects using go2rtc', link: '/#projects-using-go2rtc'},
+                    {text: 'Camera experience', link: '/#camera-experience'},
+                    {text: 'Tips', link: '/#tips'},
+                ],
+                collapsed: true,
+            },
+            {
+                text: 'Core modules',
+                items: [
+                    {text: 'app', link: '/internal/app/'},
+                    {text: 'api', link: '/internal/api/'},
+                    {text: 'streams', link: '/internal/streams/'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Main modules',
+                items: [
+                    {text: 'http', link: '/internal/http/'},
+                    {text: 'mjpeg', link: '/internal/mjpeg/'},
+                    {text: 'mp4', link: '/internal/mp4/'},
+                    {text: 'rtsp', link: '/internal/rtsp/'},
+                    {text: 'webrtc', link: '/internal/webrtc/'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Other modules',
+                items: [
+                    {text: 'hls', link: '/internal/hls/'},
+                    {text: 'homekit', link: '/internal/homekit/'},
+                    {text: 'onvif', link: '/internal/onvif/'},
+                    {text: 'rtmp', link: '/internal/rtmp/'},
+                    {text: 'webtorrent', link: '/internal/webtorrent/'},
+                    {text: 'wyoming', link: '/internal/wyoming/'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Script sources',
+                items: [
+                    {text: 'echo', link: '/internal/echo/'},
+                    {text: 'exec', link: '/internal/exec/'},
+                    {text: 'expr', link: '/internal/expr/'},
+                    {text: 'ffmpeg', link: '/internal/ffmpeg/'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Other sources',
+                items: [
+                    {text: 'alsa', link: '/internal/alsa/'},
+                    {text: 'bubble', link: '/internal/bubble/'},
+                    {text: 'doorbird', link: '/internal/doorbird/'},
+                    {text: 'dvrip', link: '/internal/dvrip/'},
+                    {text: 'eseecloud', link: '/internal/eseecloud/'},
+                    {text: 'flussonic', link: '/internal/flussonic/'},
+                    {text: 'gopro', link: '/internal/gopro/'},
+                    {text: 'isapi', link: '/internal/isapi/'},
+                    {text: 'ivideon', link: '/internal/ivideon/'},
+                    {text: 'hass', link: '/internal/hass/'},
+                    {text: 'mpegts', link: '/internal/mpegts/'},
+                    {text: 'multitrans', link: '/internal/multitrans/'},
+                    {text: 'nest', link: '/internal/nest/'},
+                    {text: 'ring', link: '/internal/ring/'},
+                    {text: 'roborock', link: '/internal/roborock/'},
+                    {text: 'tapo', link: '/internal/tapo/'},
+                    {text: 'tuya', link: '/internal/tuya/'},
+                    {text: 'v4l2', link: '/internal/v4l2/'},
+                    {text: 'wyze', link: '/internal/wyze/'},
+                    {text: 'xiaomi', link: '/internal/xiaomi/'},
+                    {text: 'yandex', link: '/internal/yandex/'},
+                ],
+                collapsed: false,
+            },
+            {
+                text: 'Helper modules',
+                items: [
+                    {text: 'debug', link: '/internal/debug/'},
+                    {text: 'ngrok', link: '/internal/ngrok/'},
+                    {text: 'pinggy', link: '/internal/pinggy/'},
+                    {text: 'srtp', link: '/internal/srtp/'},
+                ],
+                collapsed: false,
+            },
+
+        ],
+        socialLinks: [
+            {icon: "github", link: "https://github.com/AlexxIT/go2rtc"}
+        ],
+        outline: [2, 3],
+        search: {provider: 'local'},
+    },
+
+    rewrites: {
+        'README.md': 'index.md',
+        '(.*)/README.md': '(.*)/index.md',
+    },
+
+    srcDir: '..',
+    srcExclude: ['examples/', 'pkg/'],
+
+    // cleanUrls: true,
+    ignoreDeadLinks: true,
+});