BIG docs refactoring
This commit is contained in:
Alex X
@@ -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,
|
||||
});
|
||||
@@ -0,0 +1,9 @@
|
||||
# WebSite
|
||||
|
||||
These are the sources of the [go2rtc.org](https://go2rtc.org/) website. It's content published on GitHub Pages and is a mirror of [alexxit.github.io/go2rtc/](http://alexxit.github.io/go2rtc/).
|
||||
|
||||
The site contains:
|
||||
|
||||
- Project's documentation, which is compiled via [vitepress](https://github.com/vuejs/vitepress) from `README.md` files located in the root of the repository, as well as in the `internal` folder.
|
||||
- Project's API in OpenAPI format, and the [Redoc](https://github.com/Redocly/redoc) viewer
|
||||
- Project's assets (logo).
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<title>go2rtc - API</title>
|
||||
<title>API | go2rtc</title>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
||||
@@ -13,7 +13,7 @@
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<redoc spec-url="https://raw.githubusercontent.com/AlexxIT/go2rtc/master/api/openapi.yaml"></redoc>
|
||||
<redoc spec-url="openapi.yaml"></redoc>
|
||||
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
@@ -1,28 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>go2rtc</title>
|
||||
<meta http-equiv="refresh" content="2; URL='https://github.com/AlexxIT/go2rtc'"/>
|
||||
<style>
|
||||
body, html {
|
||||
height: 100%;
|
||||
margin: 0;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<img src="https://raw.githubusercontent.com/AlexxIT/go2rtc/master/assets/logo.gif" alt="go2rtc">
|
||||
<a href="https://github.com/AlexxIT/go2rtc">github.com/AlexxIT/go2rtc</a>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user