tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2024-11-14 16:10:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

rename to lower case, fix internal links

Browse Source
This commit is contained in:
simon 2023-03-21 11:12:07 +07:00
parent 8094db6965
commit 9b3de50b79
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
10 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
mkdocs/docs/Channels.md → mkdocs/docs/channels.md
View File

@ -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 ## Channels Overview
Accessible at `/channel/` of your Tube Archivist, the **Overview Page** shows a list of all channels you have indexed. 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 <img src="/assets/icon-add.png?raw=true" al
- Enter the video URL for any video and let Tube Archivist extract the channel ID for you, for example `https://www.youtube.com/watch?v=2tdiKTSdE9Y` - Enter the video URL for any video and let Tube Archivist extract the channel ID for you, for example `https://www.youtube.com/watch?v=2tdiKTSdE9Y`
- If you want to subscribe to more than one channel directly, you can add one channel per line in the text field - If you want to subscribe to more than one channel directly, you can add one channel per line in the text field
To search your channels, click on the search icon <img src="/assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;"> 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 <img src="/assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;"> to reach the search page. Start your query with `channel:`, learn more on the [search](search.md) page.
## Channel Detail ## Channel Detail
Each channel gets a set of channel detail pages. Each channel gets a set of channel detail pages.
@ -43,12 +43,12 @@ On the *Channel About* page, accessible at `/channel/<channel-id>/about/`, you c
- The button **Reindex** will reindex all channel metadata. This will also categorize existing videos as shorts or streams. - 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 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. - **Download Format**: Overwrite the download quality for videos from this channel.
- **Auto Delete**: Automatically delete watched videos from this channel after selected days. - **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. - **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 ### 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.

8
mkdocs/docs/Downloads.md → mkdocs/docs/downloads.md
View File

@ -5,12 +5,12 @@ Accessible at `/downloads/` of your Tube Archivist, this page handles all the do
## Rescan Subscriptions ## Rescan Subscriptions
The **Rescan Subscriptions** icon <img src="/assets/icon-rescan.png?raw=true" alt="rescan icon" width="20px" style="margin:0 5px;"> will start a background task to look for new videos from the channels and playlists you are subscribed to. The **Rescan Subscriptions** icon <img src="/assets/icon-rescan.png?raw=true" alt="rescan icon" width="20px" style="margin:0 5px;"> 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. 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 ## Download Queue
The **Start Download** icon <img src="/assets/icon-download.png?raw=true" alt="download icon" width="20px" style="margin:0 5px;"> 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 <img src="/assets/icon-download.png?raw=true" alt="download icon" width="20px" style="margin:0 5px;"> 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 <img src="/assets/icon-stop.png?raw=true" alt="stop icon" width="20px" style="margin:0 5px;"> will gracefully stop the download process, once the current video has been finished successfully. - The stop icon <img src="/assets/icon-stop.png?raw=true" alt="stop icon" width="20px" style="margin:0 5px;"> will gracefully stop the download process, once the current video has been finished successfully.
- The cancel icon <img src="/assets/icon-close-red.png?raw=true" alt="close icon" width="20px" style="margin:0 5px;"> 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. - The cancel icon <img src="/assets/icon-close-red.png?raw=true" alt="close icon" width="20px" style="margin:0 5px;"> 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 <img src="/assets/icon-add.png?raw=true" alt=
### Playlist ### Playlist
- Add a playlist ID or URL to add every available video in the list to the download queue, for example `https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` or `PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha`. - Add a playlist ID or URL to add every available video in the list to the download queue, for example `https://www.youtube.com/playlist?list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` or `PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha`.
- When adding a playlist to the queue, this playlist will automatically get [indexed](Playlists.md#playlist-detail). - When adding a playlist to the queue, this playlist will automatically get [indexed](playlists.md#playlist-detail).
- When you add a link to a video in a playlist, Tube Archivist assumes you want to download only the specific video and not the whole playlist, for example `https://www.youtube.com/watch?v=CINVwWHlzTY&list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` will only add one video, `CINVwWHlzTY`, to the queue. - When you add a link to a video in a playlist, Tube Archivist assumes you want to download only the specific video and not the whole playlist, for example `https://www.youtube.com/watch?v=CINVwWHlzTY&list=PL96C35uN7xGLLeET0dOWaKHkAlPsrkcha` will only add one video, `CINVwWHlzTY`, to the queue.
## The Download Queue ## The Download Queue
@ -59,4 +59,4 @@ Every video in the ignored list has two buttons:
- **Forget**: This will delete the item from the ignored list. - **Forget**: This will delete the item from the ignored list.
- **Add to Queue**: This will add the ignored video back to the download queue. - **Add to Queue**: This will add the ignored video back to the download queue.
You can delete your download queue from the [Settings](Settings.md#actions) page. You can delete your download queue from the [Settings](settings.md#actions) page.

0
mkdocs/docs/FAQ.md → mkdocs/docs/faq.md
View File

8
mkdocs/docs/index.md
View File

@ -3,10 +3,10 @@ Welcome to the official Tube Archivist Docs. This is an up-to-date documentation
## Getting Started ## Getting Started
1. [Subscribe](Channels#channels-overview) to some of your favourite YouTube channels. 1. [Subscribe](channels#channels-overview) to some of your favourite YouTube channels.
2. [Scan](Downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue. 2. [Scan](downloads#rescan-subscriptions) subscriptions to add the latest videos to the download queue.
3. [Add](Downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download. 3. [Add](downloads#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download.
4. [Download](Downloads#download-queue) and let **Tube Archivist** do it's thing. 4. [Download](downloads#download-queue) and let **Tube Archivist** do it's thing.
5. Sit back and enjoy your archived and indexed collection! 5. Sit back and enjoy your archived and indexed collection!
## General Navigation ## General Navigation

8
mkdocs/docs/Playlists.md → mkdocs/docs/playlists.md
View File

@ -1,11 +1,11 @@
# Playlist Overview and Playlist Detail Page # Playlist Pages
The playlists are organized in two different levels, similar as the [channels](Channels): The playlists are organized in two different levels, similar as the [channels](channels.md):
## Playlist Overview ## Playlist Overview
Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels. Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows a list of all playlists you have indexed over all your channels.
- You can filter that list to show only subscribed to playlists with the toggle. - You can filter that list to show only subscribed to playlists with the toggle.
You can index playlists of a channel from the channel detail page as described [here](Channels#channel-detail). You can index playlists of a channel from the channel detail page as described [here](channels.md#channel-detail).
The **Subscribe to Playlist** button <img src="/assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to subscribe to playlists. You have a few options: The **Subscribe to Playlist** button <img src="/assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to subscribe to playlists. You have a few options:
@ -16,7 +16,7 @@ The **Subscribe to Playlist** button <img src="/assets/icon-add.png?raw=true" al
- If you want to subscribe to more than one playlist directly, you can add one playlist per line in the text field - If you want to subscribe to more than one playlist directly, you can add one playlist per line in the text field
!!! note !!! note
It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](Downloads.md#rescan-subscriptions). It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](downloads.md#rescan-subscriptions).
You can search your indexed playlists by clicking on the search icon <img src="/assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;">. This will open a dedicated page. You can search your indexed playlists by clicking on the search icon <img src="/assets/icon-search.png?raw=true" alt="search icon" width="20px" style="margin:0 5px;">. This will open a dedicated page.

0
mkdocs/docs/Search.md → mkdocs/docs/search.md
View File

0
mkdocs/docs/Settings.md → mkdocs/docs/settings.md
View File

0
mkdocs/docs/Users.md → mkdocs/docs/users.md
View File

4
mkdocs/docs/Video.md → mkdocs/docs/video.md
View File

@ -1,7 +1,7 @@
# Video Page # Video Page
Every video downloaded gets a dedicated page accessible at `/video/<video-id>/` of your Tube Archivist. Throughout the interface, click on a video title to access the video page. Every video downloaded gets a dedicated page accessible at `/video/<video-id>/` 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 **Reindex** will reindex the metadata of this video.
- The button **Download File** will download the media file in the browser. - 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. The video description is truncated to the first few lines, click on *show more* to expand the whole description.
## Playlist ## 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. Clicking on the next or previous video name or thumbnail will bring you to that dedicated video page.

16
mkdocs/mkdocs.yml
View File

@ -3,14 +3,14 @@ site_url: https://docs.tubearchivist.com
nav: nav:
- Home: 'index.md' - Home: 'index.md'
- User Guide: - User Guide:
- 'Channels Overview and Channel Detail Page': 'Channels.md' - 'FAQ': 'faq.md'
- 'Downloads Page': 'Downloads.md' - 'Downloads Page': 'downloads.md'
- 'FAQ': 'FAQ.md' - 'Channels Pages': 'channels.md'
- 'Playlists': 'Playlists.md' - 'Video': 'video.md'
- 'Search': 'Search.md' - 'Playlists Pages': 'playlists.md'
- 'Users': 'Users.md' - 'Search': 'search.md'
- 'Video': 'Video.md' - 'Users': 'users.md'
- 'Settings': 'Settings.md' - 'Settings': 'settings.md'
- Installation: - Installation:
- 'Unraid': 'installation/unraid.md' - 'Unraid': 'installation/unraid.md'
- 'Synology': 'installation/synology.md' - 'Synology': 'installation/synology.md'