Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jmbannon committed Nov 24, 2024
1 parent 8a0a0a6 commit 1bbd585
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
16 changes: 1 addition & 15 deletions docs/source/prebuilt_presets/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,7 @@ Helper Presets

.. hint::

Apply presets to your subscriptions using pipes:

.. code-block:: yaml
:caption: Pipes can separate presets and values to apply them to all subscriptions below them.
Plex TV Show by Date | best_video_quality:
= Documentaries | chunk_initial_download:
"NOVA PBS": "https://www.youtube.com/@novapbs"
"National Geographic": "https://www.youtube.com/@NatGeo"
= Documentaries:
"Cosmos - What If": "https://www.youtube.com/playlist?list=PLZdXRHYAVxTJno6oFF9nLGuwXNGYHmE8U"
Common presets are not usable by themselves- setting one of these as the sole preset of your subscription and attempting to download will not work. But you can add these presets to quickly modify an existing preset to better suit your needs.
See how to apply helper presets :doc:`here </prebuilt_presets/index>`

Only Recent
-----------
Expand Down
22 changes: 21 additions & 1 deletion docs/source/prebuilt_presets/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,27 @@ Prebuilt Presets
================

``ytdl-sub`` offers a number of built-in presets using best practices for formatting
media in various players. For advanced users, you can review the prebuilt preset
media in various players.

.. hint::

Apply multiple presets to your subscriptions using pipes. Pipes can define multiple presets and values
on the same line to apply to all subscriptions nested below them.

.. code-block:: yaml
:caption: Applies Max Video Quality preset to all TV shows, and Chunk Downloads preset to some
Plex TV Show by Date | Max Video Quality:
= Documentaries | Chunk Downloads:
"NOVA PBS": "https://www.youtube.com/@novapbs"
"National Geographic": "https://www.youtube.com/@NatGeo"
= Documentaries:
"Cosmos - What If": "https://www.youtube.com/playlist?list=PLZdXRHYAVxTJno6oFF9nLGuwXNGYHmE8U"
For advanced users, you can review the prebuilt preset
definitions :doc:`here </config_reference/prebuilt_presets/index>`.

.. toctree::
Expand Down
4 changes: 4 additions & 0 deletions docs/source/prebuilt_presets/media_quality.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Media Quality Presets
======================

.. hint::

See how to apply media quality presets :doc:`here </prebuilt_presets/index>`

Video
-----
The following presets set video quality specifications to yt-dlp.
Expand Down

0 comments on commit 1bbd585

Please sign in to comment.