From 9e4af60361f2269ab56832742f642855d08fb93d Mon Sep 17 00:00:00 2001 From: Darius Cepulis Date: Wed, 29 Oct 2025 23:28:55 -0500 Subject: [PATCH] docs: initial concepts and recipes (#147) --- site/src/components/HomePageDemo/Base.tsx | 2 + site/src/components/HomePageDemo/Eject.tsx | 2 + site/src/components/HomePageDemo/index.tsx | 8 +- site/src/components/NavBar/NavBar.astro | 2 +- site/src/components/docs/Container.astro | 7 - site/src/components/docs/DocsLink.astro | 7 +- site/src/components/docs/SidebarItem.astro | 2 +- site/src/components/frames/Minimal.astro | 33 ++++ site/src/components/home/HeroVideo.tsx | 4 +- site/src/components/home/config.ts | 3 - site/src/components/typography/H5.astro | 2 +- site/src/config/docs/sidebar.ts | 53 +++--- site/src/consts.ts | 18 ++ .../content/docs/concepts/architecture.mdx | 128 ++++++++++++++ site/src/content/docs/concepts/skins.mdx | 156 ++++++++++++++++++ .../content/docs/concepts/ui-components.mdx | 101 ++++++++++++ .../src/content/docs/concepts/v10-roadmap.mdx | 81 +++++++++ .../content/docs/how-to/customize-skins.mdx | 6 + site/src/content/docs/how-to/installation.mdx | 116 +++++++++++++ site/src/content/docs/how-to/write-guides.mdx | 16 +- .../fullscreen-button.mdx | 1 - .../{resources => reference}/mute-button.mdx | 1 - .../{resources => reference}/play-button.mdx | 1 - .../{resources => reference}/time-slider.mdx | 1 - .../volume-slider.mdx | 1 - .../react/FrostedSkin/FrostedSkinDemo.tsx | 27 +++ .../FullscreenButton/FullscreenButtonDemo.tsx | 5 +- .../react/MinimalSkin/MinimalSkinDemo.tsx | 26 +++ .../react/MuteButton/MuteButtonDemo.tsx | 5 +- .../react/PlayButton/PlayButtonDemo.tsx | 5 +- .../react/TimeSlider/TimeSliderDemo.tsx | 5 +- .../react/VolumeSlider/VolumeSliderDemo.tsx | 5 +- site/src/layouts/Base.astro | 2 - site/src/layouts/Blog.astro | 2 + site/src/layouts/Docs.astro | 10 +- site/src/pages/index.astro | 9 +- site/src/utils/docs/__tests__/title.test.ts | 8 +- 37 files changed, 777 insertions(+), 84 deletions(-) delete mode 100644 site/src/components/docs/Container.astro create mode 100644 site/src/components/frames/Minimal.astro delete mode 100644 site/src/components/home/config.ts create mode 100644 site/src/content/docs/concepts/architecture.mdx create mode 100644 site/src/content/docs/concepts/skins.mdx create mode 100644 site/src/content/docs/concepts/ui-components.mdx create mode 100644 site/src/content/docs/concepts/v10-roadmap.mdx create mode 100644 site/src/content/docs/how-to/customize-skins.mdx create mode 100644 site/src/content/docs/how-to/installation.mdx rename site/src/content/docs/{resources => reference}/fullscreen-button.mdx (97%) rename site/src/content/docs/{resources => reference}/mute-button.mdx (97%) rename site/src/content/docs/{resources => reference}/play-button.mdx (97%) rename site/src/content/docs/{resources => reference}/time-slider.mdx (98%) rename site/src/content/docs/{resources => reference}/volume-slider.mdx (98%) create mode 100644 site/src/examples/react/FrostedSkin/FrostedSkinDemo.tsx create mode 100644 site/src/examples/react/MinimalSkin/MinimalSkinDemo.tsx diff --git a/site/src/components/HomePageDemo/Base.tsx b/site/src/components/HomePageDemo/Base.tsx index 2a789577..3448d52b 100644 --- a/site/src/components/HomePageDemo/Base.tsx +++ b/site/src/components/HomePageDemo/Base.tsx @@ -56,6 +56,7 @@ export default function BaseDemo({ className }: { className?: string }) { aria-label="HTML implementation" titles={{ html: 'HTML', css: 'CSS', javascript: 'JavaScript' }} className={className} + maxWidth={false} > @@ -76,6 +77,7 @@ export default function BaseDemo({ className }: { className?: string }) { aria-label="React implementation" titles={{ react: 'React' }} className={className} + maxWidth={false} > diff --git a/site/src/components/HomePageDemo/Eject.tsx b/site/src/components/HomePageDemo/Eject.tsx index dc2ee374..54ec3fc1 100644 --- a/site/src/components/HomePageDemo/Eject.tsx +++ b/site/src/components/HomePageDemo/Eject.tsx @@ -36,6 +36,7 @@ export default function EjectDemo({ className }: { className?: string }) { aria-label="HTML implementation" titles={{ html: 'HTML', css: 'CSS', javascript: 'JavaScript' }} className={className} + maxWidth={false} > @@ -56,6 +57,7 @@ export default function EjectDemo({ className }: { className?: string }) { aria-label="React implementation" titles={{ react: 'React', css: 'CSS Module' }} className={className} + maxWidth={false} > diff --git a/site/src/components/HomePageDemo/index.tsx b/site/src/components/HomePageDemo/index.tsx index 38dba474..f32cd7a5 100644 --- a/site/src/components/HomePageDemo/index.tsx +++ b/site/src/components/HomePageDemo/index.tsx @@ -9,19 +9,19 @@ interface Props { export default function HomePageDemo({ className }: Props) { return (
-
+

Assemble your player

Feel at home with your framework, skin, and media source

- +
-
+

Take full control

Make your player truly your own with fully-editable components

- +
); diff --git a/site/src/components/NavBar/NavBar.astro b/site/src/components/NavBar/NavBar.astro index 8dfc0edb..b457a76c 100644 --- a/site/src/components/NavBar/NavBar.astro +++ b/site/src/components/NavBar/NavBar.astro @@ -36,7 +36,7 @@ const { class: className, dark = false } = Astro.props; style="height: var(--nav-h);" > - Video.js + Video.js v10