tubearchivist-frontend/docs/Home.md

29 lines
1.9 KiB
Markdown
Raw Normal View History

2021-09-26 04:21:54 +00:00
# Tube Archivist Wiki
**WIP**: This is work in progress!
2021-09-28 14:58:43 +00:00
Welcome to the official Tube Archivist Wiki. This is an up-to-date documentation of user functionality.
2021-09-26 04:21:54 +00:00
Table of contents:
2021-09-28 15:09:58 +00:00
* [Main](Main.md): Tube Archivist landing page
* [Channels](Channels.md): Browse your channels, handle subscriptions
* [Downloads](Downloads.md): Scanning subscriptions, handle download queue
* [Settings](Settings.md): All the configuration options
2021-09-28 14:58:43 +00:00
## Getting Started
2021-09-28 15:09:58 +00:00
1. [Subscribe](Channels.md#channels-overview) to some of your favourite YouTube channels.
2. [Scan](Downloads.md#rescan-subscriptions) subscriptions to add the latest videos to the download queue.
3. [Add](Downloads.md#add-to-download-queue) additional videos, channels or playlist - ignore the ones you don't want to download.
4. [Download](Downloads.md#download-queue) and let **Tube Archivist** do it's thing.
2021-09-28 14:58:43 +00:00
5. Sit back and enjoy your archived and indexed collection!
## General Navigation
* Clicking on the channel name or the channel icon brings you to the dedicated channel page to show videos from to that channel.
* Clicking on a video title brings you to the dedicated video page and shows additional details.
* Clicking on a video thumbnail opens the video player and starts streaming the selected video.
* Hover over the playing video to show additional control options.
Videos you *haven't* marked as **watched** show a empty checkbox, click on it to mark it as watched:
<img src="../tubearchivist/static/img/icon-unseen.svg?raw=true" alt="unseen icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);">
Videos you *have* marked as watched, will show as a filled checkbox:
<img src="../tubearchivist/static/img/icon-seen.svg?raw=true" alt="seen icon" width="20px" style="filter:invert(50%) sepia(9%) saturate(2940%) hue-rotate(122deg) brightness(94%) contrast(90%);">