From 08fcb6c1962fe5602b7c243a363ae7c213b9ba10 Mon Sep 17 00:00:00 2001 From: Korbs Date: Sun, 1 Dec 2024 01:44:43 -0500 Subject: [PATCH] :rocket: Init --- .gitignore | 1 + config.json | 82 ++++++++++++++++++++++++++++++++++++++++++ docker-compose.yml | 17 +++++++++ docs/audio-source.mdx | 42 ++++++++++++++++++++++ docs/basic-setup.mdx | 29 +++++++++++++++ docs/compatibility.mdx | 45 +++++++++++++++++++++++ docs/home.mdx | 9 +++++ docs/installation.mdx | 14 ++++++++ docs/introduction.mdx | 24 +++++++++++++ docs/live.mdx | 13 +++++++ docs/milieu.mdx | 11 ++++++ docs/setting-menus.mdx | 77 +++++++++++++++++++++++++++++++++++++++ docs/subtitles.mdx | 22 ++++++++++++ docs/toggles.mdx | 15 ++++++++ docs/youtube.mdx | 20 +++++++++++ 15 files changed, 421 insertions(+) create mode 100644 .gitignore create mode 100644 config.json create mode 100644 docker-compose.yml create mode 100644 docs/audio-source.mdx create mode 100644 docs/basic-setup.mdx create mode 100644 docs/compatibility.mdx create mode 100644 docs/home.mdx create mode 100644 docs/installation.mdx create mode 100644 docs/introduction.mdx create mode 100644 docs/live.mdx create mode 100644 docs/milieu.mdx create mode 100644 docs/setting-menus.mdx create mode 100644 docs/subtitles.mdx create mode 100644 docs/toggles.mdx create mode 100644 docs/youtube.mdx diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f4bddde --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +dists \ No newline at end of file diff --git a/config.json b/config.json new file mode 100644 index 0000000..51341d8 --- /dev/null +++ b/config.json @@ -0,0 +1,82 @@ +{ + "SiteSettings": { + "OrgName": "MinPluto", + "SiteName": "Zorn", + "SiteProtocol": "https", + "SiteDomain": "zorn.docs.sudovanilla.org", + "SiteBase": "", + "MetaColor": "", + "WhiteLabel": "true", + "FooterVersion": "true" + }, + "HeaderItems": [ + { + "text": "Demo", + "link": "https://zorn.demo.sudovanilla.org/" + }, + { + "text": "Package", + "link": "https://npm.sudovanilla.org/-/web/detail/@minpluto/zorn" + }, + { + "text": "Documentation", + "link": "/introduction/" + }, + { + "text": "Source Code", + "link": "https://ark.sudovanilla.org/MinPluto/Zorn/" + } + ], + "SidebarItems": [ + { + "heading": "Introduction" + }, + { + "text": "Introduction", + "link": "/introduction/" + }, + { + "text": "Installation", + "link": "/installation/" + }, + { + "text": "Compatibility", + "link": "/compatibility/" + }, + { + "heading": "Usage" + }, + { + "text": "Basic Setup", + "link": "/basic-setup/" + }, + { + "text": "Audio Source", + "link": "/audio-source/" + }, + { + "text": "Setting Menus", + "link": "/setting-menus/" + }, + { + "text": "Toggles", + "link": "/toggles/" + }, + { + "text": "Subtitles", + "link": "/subtitles/" + }, + { + "text": "Milieu", + "link": "/milieu/" + }, + { + "text": "HLS", + "link": "/live/" + }, + { + "text": "YouTube", + "link": "/youtube/" + } + ] +} \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..cea8599 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,17 @@ +services: + butterflyvu: + image: ark.sudovanilla.org/korbs/butterflyvu:amd64 + network_mode: bridge + volumes: + - ./config.json:/app/config.json + - ./docs/home.mdx:/app/src/content/home.mdx + - ./docs/:/app/src/content/docs/ + - ./dists/:/app/dist/ + + nginx: + image: nginx:latest + restart: unless-stopped + ports: + - 4243:80 + volumes: + - ./dists/:/usr/share/nginx/html/ \ No newline at end of file diff --git a/docs/audio-source.mdx b/docs/audio-source.mdx new file mode 100644 index 0000000..36d6eb2 --- /dev/null +++ b/docs/audio-source.mdx @@ -0,0 +1,42 @@ +--- +Title: Audio Source +Type: Document +--- + +import {Prism} from "@astrojs/prism" +import {Zorn} from "@minpluto/zorn" + + + +Since Zorn was originally built for the MinPluto frontend project, there are scenarios where the video source has no audio to get higher quality options. If you're in a scenario where the video source is missing audio, but you do have the audio itself, you can add that audio source to the video player. A separated ` + + +`}/> + +Remember to add it as a slot with the slot name of `extra-menus`. \ No newline at end of file diff --git a/docs/subtitles.mdx b/docs/subtitles.mdx new file mode 100644 index 0000000..7bdd237 --- /dev/null +++ b/docs/subtitles.mdx @@ -0,0 +1,22 @@ +--- +Title: Subtitles +Type: Document +--- + +import {Prism} from "@astrojs/prism" +import {Zorn} from "@minpluto/zorn" + +![Native HTML5 Subtitles (Firefox)](https://md.sudovanilla.org/images/subtitles-example-native-html5.png) + +To apply subtitles to the video player, add a slot for tracks and insert HTML5 [`textTracks`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/textTracks). Make sure to set the `label` and `srclang`. + + + + + + + +`}/> + +When the `Subtitles` option is enabled, a subtitles button will appear automatically in the control on the right side and a menu will be generated for you. diff --git a/docs/toggles.mdx b/docs/toggles.mdx new file mode 100644 index 0000000..22dbef7 --- /dev/null +++ b/docs/toggles.mdx @@ -0,0 +1,15 @@ +--- +Title: Toggles +Type: Document +--- + +import {Prism} from "@astrojs/prism" +import {Zorn} from "@minpluto/zorn" + +Zorn has plent of controls to show, some are enabled or disabled by default with their toggle option. + +**Skip Backward and Forwards** + +By default, these buttons are hidden. If you want to show them, just add the `ShowBackAndForward` option: + +`}/> \ No newline at end of file diff --git a/docs/youtube.mdx b/docs/youtube.mdx new file mode 100644 index 0000000..35992f0 --- /dev/null +++ b/docs/youtube.mdx @@ -0,0 +1,20 @@ +--- +Title: YouTube +Type: Document +--- + +import {Prism} from "@astrojs/prism" +import {Zorn} from "@minpluto/zorn" + +Zorn supports YouTube videos, using Invidious. Set the video id and quality in Zorn. If you do not set the quality, it'll default to `137`, which is the itag for 1080p. + +`}/> + +If you're setting the quality to 1080p or up, using `Audio` is required for Dash support. + +| Qaulity | iTag | +|-----------|------| +| **4320p** | 272 | +| **2160p** | 315 | +| **1080p** | 137 | +| **720p** | 302 | \ No newline at end of file