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

fix nested list format

Browse Source
This commit is contained in:
simon 2023-03-22 16:12:50 +07:00
parent 27896c7505
commit b234cb145a
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
3 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
mkdocs/docs/downloads.md
View File

@ -27,16 +27,18 @@ The **Add to Download Queue** icon <img src="/assets/icon-add.png?raw=true" alt=
### Channels ### Channels
- When adding a channel, Tube Archivist will ignore the channel page size as described above, this is meant for an initial download of the whole channel. You can still ignore selected videos from the queue before starting the download. - When adding a channel, Tube Archivist will ignore the channel page size as described above, this is meant for an initial download of the whole channel. You can still ignore selected videos from the queue before starting the download.
- Download a complete channel including shorts and streams by entering: - Download a complete channel including shorts and streams by entering:
- Channel ID: `UCBa659QWEk1AI4Tg--mrJ2A` - Channel ID: `UCBa659QWEk1AI4Tg--mrJ2A`
- Channel URL: `https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A` - Channel URL: `https://www.youtube.com/channel/UCBa659QWEk1AI4Tg--mrJ2A`
- Channel `@` alias handle: For example `@TomScottGo` - Channel `@` alias handle: For example `@TomScottGo`
- Channel alias URL: `https://www.youtube.com/@TomScottGo` - Channel alias URL: `https://www.youtube.com/@TomScottGo`
- Download videos, live streams or shorts only, by providing a partial channel URL: - Download videos, live streams or shorts only, by providing a partial channel URL:
- Videos only: `https://www.youtube.com/@IBRACORP/videos` - Videos only: `https://www.youtube.com/@IBRACORP/videos`
- Shorts only: `https://www.youtube.com/@IBRACORP/shorts` - Shorts only: `https://www.youtube.com/@IBRACORP/shorts`
- Streams only: `https://www.youtube.com/@IBRACORP/streams` - Streams only: `https://www.youtube.com/@IBRACORP/streams`
- Every other channel sub page will default to download all, for example `https://www.youtube.com/@IBRACORP/featured` will download videos and shorts and streams. - Every other channel sub page will default to download all, for example `https://www.youtube.com/@IBRACORP/featured` will download videos and shorts and streams.
### 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`.

1
mkdocs/docs/faq.md
View File

@ -13,6 +13,7 @@ Additionally to that, progress is also happening on:
- **Browser Extension**: To integrate between youtube.com and Tube Archivist. - **Browser Extension**: To integrate between youtube.com and Tube Archivist.
Defining the scope is important for the success of any project: Defining the scope is important for the success of any project:
- A scope too broad will result in development effort spreading too thin and will run into danger that his project tries to do too many things and none of them well. - A scope too broad will result in development effort spreading too thin and will run into danger that his project tries to do too many things and none of them well.
- A too narrow scope will make this project uninteresting and will exclude audiences that could also benefit from this project. - A too narrow scope will make this project uninteresting and will exclude audiences that could also benefit from this project.
- Not defining a scope will easily lead to misunderstandings and false hopes of where this project tries to go. - Not defining a scope will easily lead to misunderstandings and false hopes of where this project tries to go.

4
mkdocs/docs/settings.md
View File

@ -41,8 +41,8 @@ Additional settings passed to yt-dlp.
## Comments ## Comments
- **Download and index comments**: Set your configuration for downloading and indexing comments. This takes the same values as documented in the `max_comments` section for the youtube extractor of [yt-dlp](https://github.com/yt-dlp/yt-dlp#youtube). Add without space between the four different fields: *max-comments,max-parents,max-replies,max-replies-per-thread*. Example: - **Download and index comments**: Set your configuration for downloading and indexing comments. This takes the same values as documented in the `max_comments` section for the youtube extractor of [yt-dlp](https://github.com/yt-dlp/yt-dlp#youtube). Add without space between the four different fields: *max-comments,max-parents,max-replies,max-replies-per-thread*. Example:
- `all,100,all,30`: Get 100 max-parents and 30 max-replies-per-thread. - `all,100,all,30`: Get 100 max-parents and 30 max-replies-per-thread.
- `1000,all,all,50`: Get a total of 1000 comments over all, 50 replies per thread. - `1000,all,all,50`: Get a total of 1000 comments over all, 50 replies per thread.
- **Comment sort method**: Change sort method between *top* or *new*. The default is *top*, as decided by YouTube. - **Comment sort method**: Change sort method between *top* or *new*. The default is *top*, as decided by YouTube.
- The [Refresh Metadata](#refresh-metadata) background task will get comments from your already archived videos, spreading the requests out over time. - The [Refresh Metadata](#refresh-metadata) background task will get comments from your already archived videos, spreading the requests out over time.