From 9b3de50b791ad26181b14ca45605bd5794305c60 Mon Sep 17 00:00:00 2001 From: simon Date: Tue, 21 Mar 2023 11:12:07 +0700 Subject: [PATCH] rename to lower case, fix internal links --- mkdocs/docs/{Channels.md => channels.md} | 12 ++++++------ mkdocs/docs/{Downloads.md => downloads.md} | 8 ++++---- mkdocs/docs/{FAQ.md => faq.md} | 0 mkdocs/docs/index.md | 8 ++++---- mkdocs/docs/{Playlists.md => playlists.md} | 8 ++++---- mkdocs/docs/{Search.md => search.md} | 0 mkdocs/docs/{Settings.md => settings.md} | 0 mkdocs/docs/{Users.md => users.md} | 0 mkdocs/docs/{Video.md => video.md} | 4 ++-- mkdocs/mkdocs.yml | 16 ++++++++-------- 10 files changed, 28 insertions(+), 28 deletions(-) rename mkdocs/docs/{Channels.md => channels.md} (92%) rename mkdocs/docs/{Downloads.md => downloads.md} (95%) rename mkdocs/docs/{FAQ.md => faq.md} (100%) rename mkdocs/docs/{Playlists.md => playlists.md} (91%) rename mkdocs/docs/{Search.md => search.md} (100%) rename mkdocs/docs/{Settings.md => settings.md} (100%) rename mkdocs/docs/{Users.md => users.md} (100%) rename mkdocs/docs/{Video.md => video.md} (93%) diff --git a/mkdocs/docs/Channels.md b/mkdocs/docs/channels.md similarity index 92% rename from mkdocs/docs/Channels.md rename to mkdocs/docs/channels.md index a3e62e3..cfa76dd 100644 --- a/mkdocs/docs/Channels.md +++ b/mkdocs/docs/channels.md @@ -1,6 +1,6 @@ -# Channels Overview and Channel Detail Page +# Channels Pages -The channels are organized on two different levels, similar to the [playlists](Playlists.md): +The channels are organized on two different levels, similar to the [playlists](playlists.md): ## Channels Overview Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed. @@ -17,7 +17,7 @@ The **Subscribe to Channels** button search icon to reach the search page. Start your query with `channel:`, learn more on the [search](Search.md) page. +To search your channels, click on the search icon search icon to reach the search page. Start your query with `channel:`, learn more on the [search](search.md) page. ## Channel Detail Each channel gets a set of channel detail pages. @@ -43,12 +43,12 @@ On the *Channel About* page, accessible at `/channel//about/`, you c - The button **Reindex** will reindex all channel metadata. This will also categorize existing videos as shorts or streams. - The button **Reindex Videos** will reindex metadata for all videos in this channel. -The channel customize form gives options to change settings on a per channel basis. Any configurations here will overwrite your configurations from the [settings](Settings.md) page. +The channel customize form gives options to change settings on a per channel basis. Any configurations here will overwrite your configurations from the [settings](settings.md) page. - **Download Format**: Overwrite the download quality for videos from this channel. - **Auto Delete**: Automatically delete watched videos from this channel after selected days. - **Index Playlists**: Automatically add all Playlists with at least a video downloaded to your index. Only do this for channels where you care about playlists as this will slow down indexing new videos for having to check which playlist this belongs to. -- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. Customize per channel: You can *disable* or *enable* SponsorBlock for certain channels only to overwrite the behavior set on the [settings](Settings.md) page. Selecting *unset* will remove the overwrite and your setting will fall back to the default on the settings page. +- **SponsorBlock**: Using [SponsorBlock](https://sponsor.ajay.app/) to get and skip sponsored content. Customize per channel: You can *disable* or *enable* SponsorBlock for certain channels only to overwrite the behavior set on the [settings](settings.md) page. Selecting *unset* will remove the overwrite and your setting will fall back to the default on the settings page. ### Downloads -If you have any videos from this channel pending in the download queue, a *Downloads* link will show, bringing you directly to the [downloads](Downloads.md) page, filtering the list by the selected channel. +If you have any videos from this channel pending in the download queue, a *Downloads* link will show, bringing you directly to the [downloads](downloads.md) page, filtering the list by the selected channel. diff --git a/mkdocs/docs/Downloads.md b/mkdocs/docs/downloads.md similarity index 95% rename from mkdocs/docs/Downloads.md rename to mkdocs/docs/downloads.md index 33c6fd4..3e248ff 100644 --- a/mkdocs/docs/Downloads.md +++ b/mkdocs/docs/downloads.md @@ -5,12 +5,12 @@ Accessible at `/downloads/` of your Tube Archivist, this page handles all the do ## Rescan Subscriptions The **Rescan Subscriptions** icon rescan icon will start a background task to look for new videos from the channels and playlists you are subscribed to. -Tube Archivist will get available *videos*, *shorts* and *streams* from each channel, you can define the channel and playlist page size on the [settings page](Settings.md#subscriptions). With the default page size, expect this process to take around 2-3 seconds for each channel or playlist you are subscribed to. A status message will show the progress. +Tube Archivist will get available *videos*, *shorts* and *streams* from each channel, you can define the channel and playlist page size on the [settings page](settings.md#subscriptions). With the default page size, expect this process to take around 2-3 seconds for each channel or playlist you are subscribed to. A status message will show the progress. Then for every video found, **Tube Archivist** will skip the video if it has already been downloaded or if you added it to the *ignored* list before. All the other videos will get added to the download queue. Expect this to take around 2 seconds for each video as **Tube Archivist** needs to grab some additional metadata and artwork. New videos will get added at the bottom of the download queue. ## Download Queue -The **Start Download** icon download icon will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](Settings.md#downloads). Once the process started, a progress message will show with additional details and controls: +The **Start Download** icon download icon will start the download process starting from the top of the queue. Take a look at the relevant settings on the [Settings Page](settings.md#downloads). Once the process started, a progress message will show with additional details and controls: - The stop icon stop icon will gracefully stop the download process, once the current video has been finished successfully. - The cancel icon close icon is equivalent to killing the process and will stop the download immediately. Any leftover files will get deleted, the canceled video will still be available in the download queue. @@ -40,7 +40,7 @@ The **Add to Download Queue** icon ### opens a text field to subscribe to playlists. You have a few options: @@ -16,7 +16,7 @@ The **Subscribe to Playlist** button search icon. This will open a dedicated page. diff --git a/mkdocs/docs/Search.md b/mkdocs/docs/search.md similarity index 100% rename from mkdocs/docs/Search.md rename to mkdocs/docs/search.md diff --git a/mkdocs/docs/Settings.md b/mkdocs/docs/settings.md similarity index 100% rename from mkdocs/docs/Settings.md rename to mkdocs/docs/settings.md diff --git a/mkdocs/docs/Users.md b/mkdocs/docs/users.md similarity index 100% rename from mkdocs/docs/Users.md rename to mkdocs/docs/users.md diff --git a/mkdocs/docs/Video.md b/mkdocs/docs/video.md similarity index 93% rename from mkdocs/docs/Video.md rename to mkdocs/docs/video.md index b0509ce..8b42adb 100644 --- a/mkdocs/docs/Video.md +++ b/mkdocs/docs/video.md @@ -1,7 +1,7 @@ # Video Page Every video downloaded gets a dedicated page accessible at `/video//` of your Tube Archivist. Throughout the interface, click on a video title to access the video page. -Clicking on the channel name or the channel icon will bring you to the dedicated channel detail [page](Channels.md#channel-detail). +Clicking on the channel name or the channel icon will bring you to the dedicated channel detail [page](channels.md#channel-detail). - The button **Reindex** will reindex the metadata of this video. - The button **Download File** will download the media file in the browser. @@ -12,7 +12,7 @@ If available, a tag cloud will show, representing the tags set by the uploader. The video description is truncated to the first few lines, click on *show more* to expand the whole description. ## Playlist -When available, a playlist navigation will show at the bottom. Clicking on the playlist name will bring you to the dedicated [Playlist Detail](Playlists.md#playlist-detail) page showing all videos downloaded from that playlist. The number in square brackets indicates the position of the current video in that playlist. +When available, a playlist navigation will show at the bottom. Clicking on the playlist name will bring you to the dedicated [Playlist Detail](playlists.md#playlist-detail) page showing all videos downloaded from that playlist. The number in square brackets indicates the position of the current video in that playlist. Clicking on the next or previous video name or thumbnail will bring you to that dedicated video page. diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml index 66ea296..25aa61e 100644 --- a/mkdocs/mkdocs.yml +++ b/mkdocs/mkdocs.yml @@ -3,14 +3,14 @@ site_url: https://docs.tubearchivist.com nav: - Home: 'index.md' - User Guide: - - 'Channels Overview and Channel Detail Page': 'Channels.md' - - 'Downloads Page': 'Downloads.md' - - 'FAQ': 'FAQ.md' - - 'Playlists': 'Playlists.md' - - 'Search': 'Search.md' - - 'Users': 'Users.md' - - 'Video': 'Video.md' - - 'Settings': 'Settings.md' + - 'FAQ': 'faq.md' + - 'Downloads Page': 'downloads.md' + - 'Channels Pages': 'channels.md' + - 'Video': 'video.md' + - 'Playlists Pages': 'playlists.md' + - 'Search': 'search.md' + - 'Users': 'users.md' + - 'Settings': 'settings.md' - Installation: - 'Unraid': 'installation/unraid.md' - 'Synology': 'installation/synology.md'