From e9788f8030faf7e2fc9087b90118353e8c00bfa2 Mon Sep 17 00:00:00 2001 From: bastimeyer Date: Sat, 25 Nov 2023 16:18:48 +0100 Subject: [PATCH] docs: clean up applications and thirdparty pages --- docs/_applications.rst | 25 ------------------------- docs/applications.rst | 5 +---- docs/thirdparty.rst | 36 ++++++++++++++---------------------- 3 files changed, 15 insertions(+), 51 deletions(-) delete mode 100644 docs/_applications.rst diff --git a/docs/_applications.rst b/docs/_applications.rst deleted file mode 100644 index 936ff7bd..00000000 --- a/docs/_applications.rst +++ /dev/null @@ -1,25 +0,0 @@ -:orphan: - - -.. raw:: html - - - -.. |Windows| raw:: html - - - -.. |MacOS| raw:: html - - - -.. |Linux| raw:: html - - diff --git a/docs/applications.rst b/docs/applications.rst index d69bb192..4da1f1c0 100644 --- a/docs/applications.rst +++ b/docs/applications.rst @@ -1,6 +1,3 @@ -.. include:: _applications.rst - - Streamlink Applications ======================= @@ -13,7 +10,7 @@ Streamlink Twitch GUI :Description: A multi platform Twitch.tv browser for Streamlink :Type: Graphical User Interface -:OS: |Windows| |MacOS| |Linux| +:OS: :fab:`windows;fa-xl` :fab:`apple;fa-xl` :fab:`linux;fa-xl` :Author: `Sebastian Meyer `_ :Website: https://streamlink.github.io/streamlink-twitch-gui :Source code: https://github.com/streamlink/streamlink-twitch-gui diff --git a/docs/thirdparty.rst b/docs/thirdparty.rst index de2f5f5f..4ae2c1b2 100644 --- a/docs/thirdparty.rst +++ b/docs/thirdparty.rst @@ -7,13 +7,13 @@ 2. add your new entry to the bottom of the list 3. at least provide the required fields (in the same order) - "Description" (a brief text describing your application) - - "Type" (eg. Graphical User Interface, CLI wrapper, etc.) - - "OS" (please use the available substitutions) - - "Author" (if possible, include a link to the creator's Github/Gitlab profile, etc. or a contact email address) + - "Type" (e.g. Graphical User Interface, CLI wrapper, etc.) + - "OS" (please use the available icons) + - "Author" (if possible, include a link to the creator's GitHub/GitLab profile, etc. or a contact email address) - "Website" 4. use an image - in the jpeg or png format - - with a static and reliable !!!https!!! URL (use Github or an image hoster like Imgur, etc.) + - with a static and reliable !!!https!!! URL (use GitHub or an image hoster like Imgur, etc.) - with a reasonable size and aspect ratio - with a decent compression quality - that is not too large (at most 1 MiB allowed, the smaller the better) @@ -27,16 +27,10 @@ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -.. include:: _applications.rst - -.. |br| raw:: html - -
- - Third Party Applications ======================== +Help us extend this list by sending us a pull request on GitHub. Thanks! .. content list start @@ -44,12 +38,13 @@ LiveProxy --------- :Description: Local proxy server between Streamlink and an URL -:OS: |Windows| |MacOS| |Linux| +:OS: :fab:`windows;fa-xl` :fab:`apple;fa-xl` :fab:`linux;fa-xl` :Author: `back-to `_ :Website: https://liveproxy.github.io :Source code: https://github.com/back-to/liveproxy -:Info: LiveProxy allows Streamlink to be easy accessible from **m3u** playlists, |br| - it is also available for **Kodi Leia** and **Enigma2** devices. |br| +:Info: LiveProxy allows Streamlink to be easy accessible from **m3u** playlists, + it is also available for **Kodi Leia** and **Enigma2** devices. + A detailed guide can be found on the website. Wtwitch @@ -61,12 +56,12 @@ Wtwitch :Description: Browse Twitch streams; subscribe to streamers locally without an account :Type: TUI (terminal user interface) -:OS: |Linux| |MacOS| +:OS: :fab:`apple;fa-xl` :fab:`linux;fa-xl` :Author: `Hunter Peavey `_ :Website: https://git.sr.ht/~krathalan/wtwitch -:Info: wtwitch is a Bash program that lets you browse the top games on Twitch, the |br| - top streamers for a given game, and lets you check the status of streamers you |br| - subscribe to. Open streams easily with settings that save your preferred quality |br| +:Info: wtwitch is a Bash program that lets you browse the top games on Twitch, the + top streamers for a given game, and lets you check the status of streamers you + subscribe to. Open streams easily with settings that save your preferred quality and player. A man page comes with the AUR package or can be compiled manually. OBS-Streamlink @@ -74,7 +69,7 @@ OBS-Streamlink :Description: OBS source plugin for embedding streams using Streamlink :Type: OBS Plugin -:OS: |Windows| +:OS: :fab:`windows;fa-xl` :Author: `DD Center `_ :Website: https://github.com/dd-center/obs-streamlink :Info: OBS-Streamlink is a plugin for OBS (Open Broadcaster Software) which allows @@ -82,6 +77,3 @@ OBS-Streamlink multi-platform live streams and for live commentators. .. content list end - - -Help us extend this list by sending us a pull request on Github. Thanks!