Skip to content

Commit

Permalink
documentation: Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@darkhz
darkhz committed Aug 1, 2023
0 parents commit 7a28da8
Show file tree
Hide file tree
Showing 407 changed files with 20,383 additions and 0 deletions.
Empty file added .github/workflows/static.yml
Empty file.
171 changes: 171 additions & 0 deletions docs/Additional_Notes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<title>Additional Notes - InvidTUI</title>
<meta name="description" content="A cross-platform terminal-based Invidious client">
<meta name="author" content="darkhz">
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">

<link rel="icon" href="themes/daux/img/favicon-navy.png" type="image/x-icon">

<!-- Mobile -->
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<!-- JS -->
<script>
window.base_url = "";
document.documentElement.classList.remove('no-js');
</script>

<!-- Font -->

<!-- CSS -->
<link href='themes/daux/css/theme-navy.min.css' rel='stylesheet' type='text/css'>
<link href='daux_libraries/search.css' rel='stylesheet' type='text/css'>
</head>
<body class="">
<div class="Columns content">
<aside class="Columns__left Collapsible">
<button type="button" class="Button Collapsible__trigger" aria-controls="sidebar_content" aria-expanded="false" aria-label="Toggle navigation">
<span class="Collapsible__trigger__bar"></span>
<span class="Collapsible__trigger__bar"></span>
<span class="Collapsible__trigger__bar"></span>
</button>

<a class="Brand" href="index.html">InvidTUI</a>

<form role='search' action="/" method="get" class="Search" id="search_form">
<label for="search_input">
<span class='u-visuallyHidden'>Search</span>
</label>
<input
type="search"
id="search_input"
class="Search__field"
placeholder="Search..."
aria-label="Search..."
autocomplete="on"
results=25
autosave=text_search
>
<label>
<input type="submit" class='u-visuallyHidden' />
<span class='u-visuallyHidden'>Search...</span>
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
</svg>
</label>
</form>

<div class="Collapsible__content" id="sidebar_content">
<!-- Navigation -->
<ul class='Nav'>
<li class='Nav__item '><a href="Installation.html">Installation</a></li>
<li class='Nav__item '><a href="Configuration.html">Configuration</a></li>
<li class='Nav__item has-children'><a href="Usage/index.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Usage</a><ul class='Nav'>
<li class='Nav__item '><a href="Usage/Command_Line_Options.html">Command Line Options</a></li>
<li class='Nav__item has-children'><a href="Usage/Keybindings/Global_Keybindings.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Keybindings</a><ul class='Nav'>
<li class='Nav__item '><a href="Usage/Keybindings/Global_Keybindings.html">Global Keybindings</a></li>
<li class='Nav__item '><a href="Usage/Keybindings/Page_Specific_Keybindings.html">Page Specific Keybindings</a></li></ul></li></ul></li>
<li class='Nav__item has-children'><a href="Pages/index.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Pages</a><ul class='Nav'>
<li class='Nav__item '><a href="Pages/Start.html">Start</a></li>
<li class='Nav__item '><a href="Pages/Search.html">Search</a></li>
<li class='Nav__item '><a href="Pages/Playlist.html">Playlist</a></li>
<li class='Nav__item '><a href="Pages/Channel.html">Channel</a></li>
<li class='Nav__item '><a href="Pages/Dashboard.html">Dashboard</a></li>
<li class='Nav__item '><a href="Pages/Downloads.html">Downloads</a></li></ul></li>
<li class='Nav__item '><a href="Authentication.html">Authentication</a></li>
<li class='Nav__item Nav__item--active'><a href="Additional_Notes.html">Additional Notes</a></li>
<li class='Nav__item '><a href="Credits.html">Credits</a></li></ul>
<div class="Links">
<hr/>
<a href="https://youtube.com/watch?v=SwPyPYukuRQ" target="_blank" rel="noopener noreferrer">Video Demo</a>
<br />
<a href="https://github.com/darkhz/invidtui" target="_blank" rel="noopener noreferrer">GitHub Repository</a>
<br />
<a href="https://github.com/darkhz/invidtui/issues" target="_blank" rel="noopener noreferrer">Help/Support/Bugs</a>
<br />
</div>


<div class="DarkModeToggler">
<hr/>
<label class="Checkbox">Dark Mode <input type="checkbox" class="ColorMode__button" />
<div class="Checkbox__indicator"></div>
</label>
</div>


<div class="PoweredBy">
<hr/>
Powered by Daux.io </div>
</div>
</aside>
<div class="Columns__right">
<div class="Columns__right__content">
<div class="doc_content">
<article class="Page">

<div class="Page__header">
<h1><a href="Additional_Notes.html">Additional Notes</a></h1>
<span class="EditOn">
<a href="https://github.com/darkhz/invidtui/blob/master/documentation/docs/06_Additional_Notes.md" target="_blank">
Edit on GitHub </a>
</span>
</div>

<div class="s-content">
<ul>
<li>
<p>Since Youtube video titles may have many unicode characters (emojis for example), it is recommended to install <strong>noto-fonts</strong> and its variants (noto-fonts-emoji for example). Refer to your distro’s documentation on how to install them. On Arch Linux for instance, you can install the fonts using pacman:
<code>pacman -S noto-fonts noto-fonts-emoji noto-fonts-extra</code><br/></p>
</li>
<li>
<p>For the video mode, only MP4 videos will be played, and currently there is no way to modify this behavior. This will change in later versions.</p>
</li>
<li>
<p>On Windows, using invidtui in Powershell/CMD will work, but use Windows Terminal for best results.</p>
</li>
<li>
<p>For certain videos where the duration is shown as “00:00”, but the published date is greater than 0s, it is most likely that the video is a live stream. Due to certain inconsistencies with the invidious API, such videos are not shown as live streams in the search results, but will show when playing.</p>
</li>
<li>
<p>Since invidtui relies on specially crafted URLs to load and display media properly, it is not recommended to edit the autogenerated playlist.</p>
</li>
<li>
<p>MPRIS support can be enabled by installing <a href="https://github.com/hoyon/mpv-mpris" class="Link--external" rel="noopener noreferrer">mpv-mpris</a>.</p>
</li>
</ul>
</div>

<nav>
<ul class="Pager">
<li class=Pager--prev><a href="Authentication.html">Previous</a></li> <li class=Pager--next><a href="Credits.html">Next</a></li> </ul>
</nav>
</article>

</div>
</div>
</div>
</div>


<!-- JS -->
<script src="themes/daux/js/main.mjs"></script>

<script>

window.searchLanguage = "";
window.searchTranslation = {"Search_one_result":"1 result","Search_results":"!count results","Search_no_results":"Nothing found","Search_common_words_ignored":"Common words are largely ignored","Search_too_short":"Search too short","Search_one_character_or_more":"Should be one character or more","Search_should_be_x_or_more":"Should be !min characters or more","Link_previous":"Previous","Link_next":"Next"};
</script>

<!-- Search -->
<script type="text/javascript" src="daux_libraries/search.min.js"></script>

<script>
window.search({'base_url': ''})
</script>
</body>
</html>
226 changes: 226 additions & 0 deletions docs/Authentication.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
<!DOCTYPE html>
<html class="no-js" lang="en">
<head>
<title>Authentication - InvidTUI</title>
<meta name="description" content="A cross-platform terminal-based Invidious client">
<meta name="author" content="darkhz">
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">

<link rel="icon" href="themes/daux/img/favicon-navy.png" type="image/x-icon">

<!-- Mobile -->
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<!-- JS -->
<script>
window.base_url = "";
document.documentElement.classList.remove('no-js');
</script>

<!-- Font -->

<!-- CSS -->
<link href='themes/daux/css/theme-navy.min.css' rel='stylesheet' type='text/css'>
<link href='daux_libraries/search.css' rel='stylesheet' type='text/css'>
</head>
<body class="">
<div class="Columns content">
<aside class="Columns__left Collapsible">
<button type="button" class="Button Collapsible__trigger" aria-controls="sidebar_content" aria-expanded="false" aria-label="Toggle navigation">
<span class="Collapsible__trigger__bar"></span>
<span class="Collapsible__trigger__bar"></span>
<span class="Collapsible__trigger__bar"></span>
</button>

<a class="Brand" href="index.html">InvidTUI</a>

<form role='search' action="/" method="get" class="Search" id="search_form">
<label for="search_input">
<span class='u-visuallyHidden'>Search</span>
</label>
<input
type="search"
id="search_input"
class="Search__field"
placeholder="Search..."
aria-label="Search..."
autocomplete="on"
results=25
autosave=text_search
>
<label>
<input type="submit" class='u-visuallyHidden' />
<span class='u-visuallyHidden'>Search...</span>
<svg class="Search__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 451 451">
<path d="M447.05 428l-109.6-109.6c29.4-33.8 47.2-77.9 47.2-126.1C384.65 86.2 298.35 0 192.35 0 86.25 0 .05 86.3.05 192.3s86.3 192.3 192.3 192.3c48.2 0 92.3-17.8 126.1-47.2L428.05 447c2.6 2.6 6.1 4 9.5 4s6.9-1.3 9.5-4c5.2-5.2 5.2-13.8 0-19zM26.95 192.3c0-91.2 74.2-165.3 165.3-165.3 91.2 0 165.3 74.2 165.3 165.3s-74.1 165.4-165.3 165.4c-91.1 0-165.3-74.2-165.3-165.4z"/>
</svg>
</label>
</form>

<div class="Collapsible__content" id="sidebar_content">
<!-- Navigation -->
<ul class='Nav'>
<li class='Nav__item '><a href="Installation.html">Installation</a></li>
<li class='Nav__item '><a href="Configuration.html">Configuration</a></li>
<li class='Nav__item has-children'><a href="Usage/index.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Usage</a><ul class='Nav'>
<li class='Nav__item '><a href="Usage/Command_Line_Options.html">Command Line Options</a></li>
<li class='Nav__item has-children'><a href="Usage/Keybindings/Global_Keybindings.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Keybindings</a><ul class='Nav'>
<li class='Nav__item '><a href="Usage/Keybindings/Global_Keybindings.html">Global Keybindings</a></li>
<li class='Nav__item '><a href="Usage/Keybindings/Page_Specific_Keybindings.html">Page Specific Keybindings</a></li></ul></li></ul></li>
<li class='Nav__item has-children'><a href="Pages/index.html" class="Nav__item__link"><i class="Nav__arrow">&nbsp;</i>Pages</a><ul class='Nav'>
<li class='Nav__item '><a href="Pages/Start.html">Start</a></li>
<li class='Nav__item '><a href="Pages/Search.html">Search</a></li>
<li class='Nav__item '><a href="Pages/Playlist.html">Playlist</a></li>
<li class='Nav__item '><a href="Pages/Channel.html">Channel</a></li>
<li class='Nav__item '><a href="Pages/Dashboard.html">Dashboard</a></li>
<li class='Nav__item '><a href="Pages/Downloads.html">Downloads</a></li></ul></li>
<li class='Nav__item Nav__item--active'><a href="Authentication.html">Authentication</a></li>
<li class='Nav__item '><a href="Additional_Notes.html">Additional Notes</a></li>
<li class='Nav__item '><a href="Credits.html">Credits</a></li></ul>
<div class="Links">
<hr/>
<a href="https://youtube.com/watch?v=SwPyPYukuRQ" target="_blank" rel="noopener noreferrer">Video Demo</a>
<br />
<a href="https://github.com/darkhz/invidtui" target="_blank" rel="noopener noreferrer">GitHub Repository</a>
<br />
<a href="https://github.com/darkhz/invidtui/issues" target="_blank" rel="noopener noreferrer">Help/Support/Bugs</a>
<br />
</div>


<div class="DarkModeToggler">
<hr/>
<label class="Checkbox">Dark Mode <input type="checkbox" class="ColorMode__button" />
<div class="Checkbox__indicator"></div>
</label>
</div>


<div class="PoweredBy">
<hr/>
Powered by Daux.io </div>
</div>
</aside>
<div class="Columns__right">
<div class="Columns__right__content">
<div class="doc_content">
<article class="Page">

<div class="Page__header">
<h1><a href="Authentication.html">Authentication</a></h1>
<span class="EditOn">
<a href="https://github.com/darkhz/invidtui/blob/master/documentation/docs/05_Authentication.md" target="_blank">
Edit on GitHub </a>
</span>
</div>

<div class="s-content">
<p>In order to use authentication-based features, like viewing and managing user feed, playlists and subscriptions, an account needs to be registered with a specific Invidious instance.</p>
<p>The following steps should be followed to obtain authentication for an instance:</p>
<ul>
<li>Obtain a <a href="#user-token">user token</a>
</li>
<li>Use invidtui to authenticate</li>
</ul>
<p>These steps can be performed for multiple invidious instances.</p>
<h1><a id="user-token" href="#user-token" class="Permalink" aria-hidden="true" title="Permalink">#</a>User Token</h1>
<p>For the user token, either a <a href="#sid">SID</a> or a generated <a href="#session-token">Session Token</a> can be used.</p>
<h2><a id="sid" href="#sid" class="Permalink" aria-hidden="true" title="Permalink">#</a>SID</h2>
<p>This is a base64 encoded text, that is automatically generated when you register an account with an Invidious instance.</p>
<p>To get your SID:</p>
<ul>
<li>
<p>Login into your Invidious instance using a web browser<br />
<img src="images/Authentication/auth_login.png" alt="auth_login" /><br /><br /></p>
</li>
<li>
<p>Once you are redirected to the homepage, click on the ‘settings’ icon<br />
<img src="images/Authentication/auth_settings.png" alt="auth_settings" /><br /><br /></p>
</li>
<li>
<p>Click on ‘Manage tokens’<br />
<img src="images/Authentication/auth_tokens.png" alt="auth_tokens" /><br /><br /></p>
</li>
<li>
<p>Copy the Base64 encoded text on top of a red background
<img src="images/Authentication/auth_sid.png" alt="auth_sid" /></p>
</li>
</ul>
<h2><a id="session-token" href="#session-token" class="Permalink" aria-hidden="true" title="Permalink">#</a>Session Token</h2>
<p>This is is a JSON text, that has to be explicitly generated after verification from the instance.</p>
<p>To get the link to your instance’s token manager, either:</p>
<ul>
<li>
<p>Copy and navigate to the link shown in the dashboard if you are authenticating within invidtui, or ,<br />
<img src="images/Authentication/auth_tokenuri.png" alt="auth_tokenuri" /><br /><br /></p>
</li>
<li>
<p>If authenticating via the command-line, type <code>invidtui --force-instance &lt;instance name&gt; --token-link</code>, copy and navigate to the displayed link.
<img src="images/Authentication/auth_tokencmd.png" alt="auth_tokencmd" /><br /><br /></p>
</li>
</ul>
<p>Once the link has been opened in a web browser:</p>
<ul>
<li>
<p>After the page loads, press ‘Yes’ and wait for the page to stop loading.<br />
<img src="images/Authentication/auth_tokenconfirm.png" alt="auth_tokenconfirm" /><br /><br /></p>
</li>
<li>
<p>Copy the session token displayed on the webpage.<br />
<img src="images/Authentication/auth_sessiontoken.png" alt="auth_sessiontoken" /></p>
</li>
</ul>
<h1><a id="authentication" href="#authentication" class="Permalink" aria-hidden="true" title="Permalink">#</a>Authentication</h1>
<p>Once the user token has been obtained, you can finish authentication either within invidtui or via the command line.</p>
<h2><a id="within-invidtui" href="#within-invidtui" class="Permalink" aria-hidden="true" title="Permalink">#</a>Within InvidTUI</h2>
<p>To authenticate within InvidTUI:</p>
<ul>
<li>First, launch invidtui with the instance<br/>
</li>
</ul>
<pre><code>invidtui --force-instance &lt;instance name&gt;
</code></pre>
<ul>
<li>Once invidtui has initialized, open the <a href="Usage/Keybindings/Page_Specific_Keybindings.html#dashboard">dashboard</a>, paste the user token in the inputbox and press <kbd><code>Enter</code></kbd>
<img src="images/Authentication/auth_dashboard.png" alt="auth_dashboard" />
</li>
</ul>
<p>The dashboard should then load the feeds from the authenticated user account.</p>
<h2><a id="via-the-command-line" href="#via-the-command-line" class="Permalink" aria-hidden="true" title="Permalink">#</a>Via the Command Line</h2>
<p>To authenticate via the command line, type:</p>
<pre><code>invidtui --force-instance &lt;instance name&gt; --token &lt;user token&gt;
</code></pre>
<p>And invidtui should initialize and authenticate the user with the instance.</p>
</div>

<nav>
<ul class="Pager">
<li class=Pager--prev><a href="Pages/Downloads.html">Previous</a></li> <li class=Pager--next><a href="Additional_Notes.html">Next</a></li> </ul>
</nav>
</article>

</div>
</div>
</div>
</div>


<!-- JS -->
<script src="themes/daux/js/main.mjs"></script>

<script>

window.searchLanguage = "";
window.searchTranslation = {"Search_one_result":"1 result","Search_results":"!count results","Search_no_results":"Nothing found","Search_common_words_ignored":"Common words are largely ignored","Search_too_short":"Search too short","Search_one_character_or_more":"Should be one character or more","Search_should_be_x_or_more":"Should be !min characters or more","Link_previous":"Previous","Link_next":"Next"};
</script>

<!-- Search -->
<script type="text/javascript" src="daux_libraries/search.min.js"></script>

<script>
window.search({'base_url': ''})
</script>
</body>
</html>
Loading

0 comments on commit 7a28da8

Please sign in to comment.