diff --git a/compositor_api/src/types/component.rs b/compositor_api/src/types/component.rs index 45c9326e4..d4f60ac23 100644 --- a/compositor_api/src/types/component.rs +++ b/compositor_api/src/types/component.rs @@ -39,13 +39,13 @@ pub struct View { /// Width of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub width: Option, /// Height of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub height: Option, @@ -129,13 +129,13 @@ pub struct Rescaler { /// Width of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub width: Option, /// Height of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub height: Option, @@ -352,13 +352,13 @@ pub struct Tiles { /// Width of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub width: Option, /// Height of a component in pixels. Exact behavior might be different based on the parent /// component: /// - If the parent component is a layout, check sections "Absolute positioning" and "Static - /// positioning" of that component. + /// positioning" of that component. /// - If the parent component is not a layout, then this field is required. pub height: Option, diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index f970b52bc..99d936c29 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -3,7 +3,7 @@ import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; const config: Config = { - title: 'Live Compositor', + title: 'LiveCompositor', favicon: 'img/favicon.png', // Set the production url of your site here @@ -65,6 +65,25 @@ const config: Config = { ], themeConfig: { + metadata: [ + { name: 'description', content: 'Real-time, low latency, programmable video & audio mixer' }, + { name: 'keywords', content: 'video, audio, mixing, real-time, live' }, + { name: 'twitter:card', content: 'summary_large_image' }, + { name: 'twitter:title', content: 'LiveCompositor' }, + { + name: 'twitter:description', + content: 'Real-time, low latency, programmable video & audio mixer', + }, + { name: 'twitter:site', content: 'ElixirMembrane' }, + { name: 'og:type', content: 'website' }, + { name: 'og:image', content: 'https://compositor.live/img/logo.webp' }, + { name: 'og:title', content: 'LiveCompositor' }, + { + name: 'og:description', + content: 'Real-time, low latency, programmable video & audio mixer', + }, + { name: 'og:url', content: 'https://compositor.live/' }, + ], colorMode: { defaultMode: 'dark', }, diff --git a/docs/index.d.ts b/docs/index.d.ts index a666151b9..0a2f49a04 100644 --- a/docs/index.d.ts +++ b/docs/index.d.ts @@ -1,4 +1,2 @@ -declare module '*.png'; declare module '*.svg'; -declare module '*.jpeg'; -declare module '*.jpg'; +declare module '*.webp'; diff --git a/docs/pages/api/components/WebView.md b/docs/pages/api/components/WebView.md index 31c145747..b32bc27bc 100644 --- a/docs/pages/api/components/WebView.md +++ b/docs/pages/api/components/WebView.md @@ -4,7 +4,7 @@ hide_table_of_contents: true title: WebView --- -[Required feature: web_renderer](../../deployment/overview.md#web-renderer-support) +[Required feature: web_renderer](../../deployment/overview.md#web-renderer-support) import Docs from "@site/pages/api/generated/component-WebView.md" diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 3755c612b..acbff1c8b 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -14,6 +14,9 @@ --ifm-color-primary-lighter: #8080f9; --ifm-color-primary-lightest: #a5abfc; --ifm-code-font-size: 95%; + --ifm-h1-font-size: 2.25rem; + --ifm-h2-font-size: 2rem; + --ifm-h3-font-size: 1.5rem; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); } diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 9e184563a..9ba32468c 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -5,7 +5,6 @@ import { GiFeather, GiBattery100, GiSpeedometer } from 'react-icons/gi'; import { IoCloudOffline } from 'react-icons/io5'; import { MdAudiotrack, MdLiveTv } from 'react-icons/md'; import Link from '@docusaurus/Link'; -import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import Heading from '@theme/Heading'; @@ -14,12 +13,12 @@ import { PropsWithChildren } from 'react'; import { IconContext, IconType } from 'react-icons'; import MembraneLogo from '@site/static/img/membrane-logo.svg'; import SwmLogo from '@site/static/img/swm-logo.svg'; -import ComposingImg from '@site/static/img/how_it_works.png'; +import ComposingImg from '@site/static/img/how_it_works.webp'; import WebGpuLogoDark from '@site/static/img/webgpu-dark.svg'; import WebGpuLogoLight from '@site/static/img/webgpu-light.svg'; -import VideoConferencingImg from '@site/static/img/videoconferencing.jpg'; -import StreamingImg from '@site/static/img/streaming.jpg'; -import BroadcastingImg from '@site/static/img/broadcasting.jpg'; +import VideoConferencingImg from '@site/static/img/videoconferencing.webp'; +import StreamingImg from '@site/static/img/streaming.webp'; +import BroadcastingImg from '@site/static/img/broadcasting.webp'; import { useColorMode } from '@docusaurus/theme-common'; import TypewriterComponent from 'typewriter-effect'; import ExampleScene from '../components/example_scene'; @@ -85,7 +84,7 @@ function HomepageHeader() { autoPlay muted src="/video/showcase.mp4" - poster="/img/showcase_poster.jpg" + poster="/img/showcase_poster.webp" style={{ width: '100%', display: 'block' }} /> @@ -98,7 +97,7 @@ function HomepageHeader() { function HowItWorks() { return (
- + How it works?

@@ -123,7 +122,7 @@ function HowItWorks() { function UseCases() { return (

- + Use cases

@@ -156,7 +155,7 @@ function UseCaseCard(props: UseCaseCardProps) { return (

- + {props.title}
@@ -173,7 +172,7 @@ function UseCaseCard(props: UseCaseCardProps) { function VisionCards() { return (
- + Vision

@@ -216,7 +215,7 @@ function VisionCard(props: PropsWithChildren) {

- + {props.title}
@@ -234,7 +233,7 @@ type FeatureProps = { function Feature(props: PropsWithChildren) { const text = (
- + {props.text}

{props.secondaryText}

@@ -263,7 +262,7 @@ function Features() { return (
- + Capabilities

Simple, powerful, fast. Pick three.

@@ -426,7 +425,7 @@ function MembranePlugin() { function Usage() { return (
- + Usage @@ -439,7 +438,7 @@ function Usage() { function Licensing() { return (
- + Licensing
@@ -495,7 +494,7 @@ function ContactUs() {
- + Contact us
@@ -517,11 +516,8 @@ function ContactUs() { } export default function Home(): JSX.Element { - const { siteConfig } = useDocusaurusContext(); return ( - +
diff --git a/docs/static/img/broadcasting.jpg b/docs/static/img/broadcasting.jpg deleted file mode 100644 index 243d0a51c..000000000 Binary files a/docs/static/img/broadcasting.jpg and /dev/null differ diff --git a/docs/static/img/broadcasting.webp b/docs/static/img/broadcasting.webp new file mode 100644 index 000000000..76490139a Binary files /dev/null and b/docs/static/img/broadcasting.webp differ diff --git a/docs/static/img/how_it_works.png b/docs/static/img/how_it_works.png deleted file mode 100644 index 0fd260236..000000000 Binary files a/docs/static/img/how_it_works.png and /dev/null differ diff --git a/docs/static/img/how_it_works.webp b/docs/static/img/how_it_works.webp new file mode 100644 index 000000000..822f1cccd Binary files /dev/null and b/docs/static/img/how_it_works.webp differ diff --git a/docs/static/img/logo.webp b/docs/static/img/logo.webp new file mode 100644 index 000000000..ad72907d5 Binary files /dev/null and b/docs/static/img/logo.webp differ diff --git a/docs/static/img/showcase_poster.jpg b/docs/static/img/showcase_poster.jpg deleted file mode 100644 index 594019f21..000000000 Binary files a/docs/static/img/showcase_poster.jpg and /dev/null differ diff --git a/docs/static/img/showcase_poster.webp b/docs/static/img/showcase_poster.webp new file mode 100644 index 000000000..902c0cca5 Binary files /dev/null and b/docs/static/img/showcase_poster.webp differ diff --git a/docs/static/img/streaming.jpg b/docs/static/img/streaming.jpg deleted file mode 100644 index efcd48651..000000000 Binary files a/docs/static/img/streaming.jpg and /dev/null differ diff --git a/docs/static/img/streaming.webp b/docs/static/img/streaming.webp new file mode 100644 index 000000000..55dc83075 Binary files /dev/null and b/docs/static/img/streaming.webp differ diff --git a/docs/static/img/videoconferencing.jpg b/docs/static/img/videoconferencing.jpg deleted file mode 100644 index 0642d5793..000000000 Binary files a/docs/static/img/videoconferencing.jpg and /dev/null differ diff --git a/docs/static/img/videoconferencing.webp b/docs/static/img/videoconferencing.webp new file mode 100644 index 000000000..ce5c39a22 Binary files /dev/null and b/docs/static/img/videoconferencing.webp differ diff --git a/docs/static/robots.txt b/docs/static/robots.txt new file mode 100644 index 000000000..0fdebbdf8 --- /dev/null +++ b/docs/static/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Disallow: + +Sitemap: https://compositor.live/sitemap.xml diff --git a/integration_tests/src/tests/push_input_before_start.rs b/integration_tests/src/tests/push_input_before_start.rs index 7a17237a3..e9368e159 100644 --- a/integration_tests/src/tests/push_input_before_start.rs +++ b/integration_tests/src/tests/push_input_before_start.rs @@ -13,7 +13,7 @@ use crate::{ /// /// Output: /// - Display entire input stream from the beginning (16 seconds). No black frames at the -/// beginning. Starts with a green color. +/// beginning. Starts with a green color. /// - Black screen for remaining 4 seconds. #[test] pub fn push_input_before_start_tcp() -> Result<()> { @@ -98,7 +98,7 @@ pub fn push_input_before_start_tcp() -> Result<()> { /// /// Output: /// - Display entire input stream from the beginning (16 seconds). No black frames at the -/// beginning. Starts with a green screen. +/// beginning. Starts with a green screen. /// - Black screen for remaining 4 seconds. #[test] pub fn push_input_before_start_udp() -> Result<()> { @@ -183,7 +183,7 @@ pub fn push_input_before_start_udp() -> Result<()> { /// /// Output: /// - Display input stream without initial 5 seconds from the beginning (11 seconds). Not black frames at the -/// beginning. Starts with a red color. Initial 5 second of input stream is missing. +/// beginning. Starts with a red color. Initial 5 second of input stream is missing. /// - Black screen for remaining 9 seconds. #[test] pub fn push_input_before_start_tcp_no_offset() -> Result<()> { @@ -268,7 +268,7 @@ pub fn push_input_before_start_tcp_no_offset() -> Result<()> { /// /// Output: /// - Display entire input stream from the beginning (16 seconds). No black frames at the -/// beginning. Starts with a red color. Initial 5 second of input stream is missing. +/// beginning. Starts with a red color. Initial 5 second of input stream is missing. /// - Black screen for remaining 19 seconds. #[test] pub fn push_input_before_start_udp_no_offset() -> Result<()> {