Deployed a308278 with MkDocs version: 1.0.3

00_Prepare_everything/index.html

@@ -9,10 +9,13 @@
   
   <link rel="shortcut icon" href="../img/favicon.ico">
   <title>Prepare everything - NewPipe Documentation</title>
+  <!-- local fonts -->
   <link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
 
   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
+  <!-- local code syntax highlighting -->
+  <link rel="stylesheet" href="../css/github.min.css" type="text/css" />
   <link rel="stylesheet" href="../css/highlight.css" type="text/css" />
   
   <script>
@@ -24,7 +27,7 @@
   
   <script src="../js/jquery-2.1.1.min.js" defer></script>
   <script src="../js/modernizr-2.8.3.min.js" defer></script>
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+  <script src="../js/highlight.min.js"></script>
   <script>hljs.initHighlightingOnLoad();</script> 
   
 </head>

01_Concept_of_the_extractor/index.html

@@ -9,10 +9,13 @@
   
   <link rel="shortcut icon" href="../img/favicon.ico">
   <title>Concept of the Extractor - NewPipe Documentation</title>
+  <!-- local fonts -->
   <link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
 
   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
+  <!-- local code syntax highlighting -->
+  <link rel="stylesheet" href="../css/github.min.css" type="text/css" />
   <link rel="stylesheet" href="../css/highlight.css" type="text/css" />
   
   <script>
@@ -24,7 +27,7 @@
   
   <script src="../js/jquery-2.1.1.min.js" defer></script>
   <script src="../js/modernizr-2.8.3.min.js" defer></script>
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+  <script src="../js/highlight.min.js"></script>
   <script>hljs.initHighlightingOnLoad();</script> 
   
 </head>

02_Concept_of_LinkHandler/index.html

@@ -9,10 +9,13 @@
   
   <link rel="shortcut icon" href="../img/favicon.ico">
   <title>Concept of LinkHandler - NewPipe Documentation</title>
+  <!-- local fonts -->
   <link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
 
   <link rel="stylesheet" href="../css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
+  <!-- local code syntax highlighting -->
+  <link rel="stylesheet" href="../css/github.min.css" type="text/css" />
   <link rel="stylesheet" href="../css/highlight.css" type="text/css" />
   
   <script>
@@ -24,7 +27,7 @@
   
   <script src="../js/jquery-2.1.1.min.js" defer></script>
   <script src="../js/modernizr-2.8.3.min.js" defer></script>
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+  <script src="../js/highlight.min.js"></script>
   <script>hljs.initHighlightingOnLoad();</script> 
   
 </head>
@@ -70,6 +73,18 @@
             
     <li class="toctree-l2"><a href="#concept-of-linkhandler">Concept of LinkHandler</a></li>
     
+        <ul>
+        
+            <li><a class="toctree-l3" href="#importand-notes-about-linkhandler">Importand notes about LinkHandler:</a></li>
+        
+            <li><a class="toctree-l3" href="#usage">Usage</a></li>
+        
+            <li><a class="toctree-l3" href="#implementation">Implementation</a></li>
+        
+            <li><a class="toctree-l3" href="#listlinkhandler-and-querylinkhandler">ListLinkHandler and QueryLinkHandler</a></li>
+        
+        </ul>
+    
 
     </ul>
 	    </li>
@@ -107,6 +122,56 @@
             <div class="section">
               
                 <h1 id="concept-of-linkhandler">Concept of LinkHandler</h1>
+<p><a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandler.html">LinkHandler</a>
+represent Links to resources like videos, search requests, channels, etc.
+The idea behind them is that a video can have multiple links pointig to it, but it has
+one unique id that represents it, like this example:</p>
+<p><a href="https://www.youtube.com/watch?v=oHg5SJYRHA0">oHg5SJYRHA0</a> can be represented as:</p>
+<ul>
+<li>https://www.youtube.com/watch?v=oHg5SJYRHA0 (default url for youtube)</li>
+<li>https://youtu.be/oHg5SJYRHA0</li>
+<li>https://m.youtube.com/watch?v=oHg5SJYRHA0</li>
+</ul>
+<h3 id="importand-notes-about-linkhandler">Importand notes about LinkHandler:</h3>
+<ul>
+<li>A simple <code>LinkHandler</code> will contain the default URL, the ID and the original url.</li>
+<li><code>LinkHandler</code> are ReadOnly</li>
+<li>LinkHandler are also used to determine which part of the extractor can handle a certain link.</li>
+<li>In order to get one you must either call
+<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandlerFactory.html#fromUrl-java.lang.String-">fromUrl()</a> or <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/LinkHandlerFactory.html#fromId-java.lang.String-">fromId()</a> of the the coresponding <code>LinkHandlerFactory</code>.</li>
+<li>Every type of Type of Resource has its own LinkHandlerFactory. Eg. YoutubeStreamLinkHandler, YoutubeChannelLinkHandler, etc.</li>
+</ul>
+<h3 id="usage">Usage</h3>
+<p>So the typical Usage for getting a LinkHandler would look like this.</p>
+<pre><code class="java">LinkHandlerFactory myLinkHandlerFactory = new MyStreamLinkHandlerFactory();
+LinkHandler myVideo = myLinkHandlerFactory.fromUrl(&quot;https://my.service.com/the_video&quot;);
+</code></pre>
+
+<h3 id="implementation">Implementation</h3>
+<p>In order to Use LinkHandler for your service you must override the apropriate LinkHandlerFactory. eg:</p>
+<pre><code class="java">class MyStreamLinkHandlerFactory extends LinkHandlerFactory {
+
+    @Override
+    public String getId(String url) throws ParsingException {
+        // Return the ID based on the url.
+    }
+
+    @Override
+    public String getUrl(String id) throws ParsingException {
+        // Return the url based on the id given.
+    }
+
+    @Override
+    public boolean onAcceptUrl(String url) throws ParsingException {
+        // Return true if this LinkHanlderFactory can handle this type of link
+    }
+}
+</code></pre>
+
+<h3 id="listlinkhandler-and-querylinkhandler">ListLinkHandler and QueryLinkHandler</h3>
+<p>List based resources like channels and playlists can be sorted, for example by date, name, or by a certain name.
+Therefore these type of resources don't just use a LinkHandler, but an extention called
+<a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/linkhandler/ListLinkHandler.html">ListLinkHandler</a></p>
               
             </div>
           </div>

css/github.min.css

@@ -0,0 +1,62 @@
+.hljs {
+ display:block;
+ overflow-x:auto;
+ padding:1em;
+ color:#333;
+ background:#f8f8f8
+}
+.hljs-comment,.hljs-quote {
+ color:#998;
+ font-style:italic
+}
+.hljs-keyword,.hljs-selector-tag,.hljs-subst {
+ color:#333;
+ font-weight:bold
+}
+.hljs-number,.hljs-literal,.hljs-variable,.hljs-template-variable,.hljs-tag .hljs-attr {
+ color:#008080
+}
+.hljs-string,.hljs-doctag {
+ color:#d14
+}
+.hljs-title,.hljs-section,.hljs-selector-id {
+ color:#900;
+ font-weight:bold
+}
+.hljs-subst {
+ font-weight:normal
+}
+.hljs-type,.hljs-class .hljs-title {
+ color:#458;
+ font-weight:bold
+}
+.hljs-tag,.hljs-name,.hljs-attribute {
+ color:#000080;
+ font-weight:normal
+}
+.hljs-regexp,.hljs-link {
+ color:#009926
+}
+.hljs-symbol,.hljs-bullet {
+ color:#990073
+}
+.hljs-built_in,.hljs-builtin-name {
+ color:#0086b3
+}
+.hljs-meta {
+ color:#999;
+ font-weight:bold
+}
+.hljs-deletion {
+ background:#fdd
+}
+.hljs-addition {
+ background:#dfd
+}
+.hljs-emphasis {
+ font-style:italic
+}
+.hljs-strong {
+ font-weight:bold
+}
+

css/highlight.css

@@ -0,0 +1,115 @@
+.codehilite code, .codehilite pre{color:#3F3F3F;background-color:#F7F7F7;
+overflow: auto;
+box-sizing: border-box;
+
+    padding: 0.01em 16px;
+    padding-top: 0.01em;
+    padding-right-value: 16px;
+    padding-bottom: 0.01em;
+    padding-left-value: 16px;
+    padding-left-ltr-source: physical;
+    padding-left-rtl-source: physical;
+    padding-right-ltr-source: physical;
+    padding-right-rtl-source: physical;
+
+border-radius: 16px !important;
+    border-top-left-radius: 16px;
+    border-top-right-radius: 16px;
+    border-bottom-right-radius: 16px;
+    border-bottom-left-radius: 16px;
+
+border: 1px solid #CCC !important;
+    border-top-width: 1px;
+    border-right-width-value: 1px;
+    border-right-width-ltr-source: physical;
+    border-right-width-rtl-source: physical;
+    border-bottom-width: 1px;
+    border-left-width-value: 1px;
+    border-left-width-ltr-source: physical;
+    border-left-width-rtl-source: physical;
+    border-top-style: solid;
+    border-right-style-value: solid;
+    border-right-style-ltr-source: physical;
+    border-right-style-rtl-source: physical;
+    border-bottom-style: solid;
+    border-left-style-value: solid;
+    border-left-style-ltr-source: physical;
+    border-left-style-rtl-source: physical;
+    border-top-color: #CCC;
+    border-right-color-value: #CCC;
+    border-right-color-ltr-source: physical;
+    border-right-color-rtl-source: physical;
+    border-bottom-color: #CCC;
+    border-left-color-value: #CCC;
+    border-left-color-ltr-source: physical;
+    border-left-color-rtl-source: physical;
+    -moz-border-top-colors: none;
+    -moz-border-right-colors: none;
+    -moz-border-bottom-colors: none;
+    -moz-border-left-colors: none;
+    border-image-source: none;
+    border-image-slice: 100% 100% 100% 100%;
+    border-image-width: 1 1 1 1;
+    border-image-outset: 0 0 0 0;
+    border-image-repeat: stretch stretch;}
+.codehilite .hll { background-color: #ffffcc }
+.codehilite .c { color: #999988; font-style: italic } /* Comment */
+.codehilite .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.codehilite .k { color: #000000; font-weight: bold } /* Keyword */
+.codehilite .o { color: #000000; font-weight: bold } /* Operator */
+.codehilite .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.codehilite .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.codehilite .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.codehilite .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.codehilite .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.codehilite .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.codehilite .gr { color: #aa0000 } /* Generic.Error */
+.codehilite .gh { color: #999999 } /* Generic.Heading */
+.codehilite .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.codehilite .go { color: #888888 } /* Generic.Output */
+.codehilite .gp { color: #555555 } /* Generic.Prompt */
+.codehilite .gs { font-weight: bold } /* Generic.Strong */
+.codehilite .gu { color: #aaaaaa } /* Generic.Subheading */
+.codehilite .gt { color: #aa0000 } /* Generic.Traceback */
+.codehilite .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+.codehilite .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+.codehilite .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+.codehilite .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+.codehilite .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+.codehilite .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.codehilite .m { color: #009999 } /* Literal.Number */
+.codehilite .s { color: #d01040 } /* Literal.String */
+.codehilite .na { color: #008080 } /* Name.Attribute */
+.codehilite .nb { color: #0086B3 } /* Name.Builtin */
+.codehilite .nc { color: #445588; font-weight: bold } /* Name.Class */
+.codehilite .no { color: #008080 } /* Name.Constant */
+.codehilite .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+.codehilite .ni { color: #800080 } /* Name.Entity */
+.codehilite .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.codehilite .nf { color: #990000; font-weight: bold } /* Name.Function */
+.codehilite .nl { color: #990000; font-weight: bold } /* Name.Label */
+.codehilite .nn { color: #555555 } /* Name.Namespace */
+.codehilite .nt { color: #000080 } /* Name.Tag */
+.codehilite .nv { color: #008080 } /* Name.Variable */
+.codehilite .ow { color: #000000; font-weight: bold } /* Operator.Word */
+.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
+.codehilite .mf { color: #009999 } /* Literal.Number.Float */
+.codehilite .mh { color: #009999 } /* Literal.Number.Hex */
+.codehilite .mi { color: #009999 } /* Literal.Number.Integer */
+.codehilite .mo { color: #009999 } /* Literal.Number.Oct */
+.codehilite .sb { color: #d01040 } /* Literal.String.Backtick */
+.codehilite .sc { color: #d01040 } /* Literal.String.Char */
+.codehilite .sd { color: #d01040 } /* Literal.String.Doc */
+.codehilite .s2 { color: #d01040 } /* Literal.String.Double */
+.codehilite .se { color: #d01040 } /* Literal.String.Escape */
+.codehilite .sh { color: #d01040 } /* Literal.String.Heredoc */
+.codehilite .si { color: #d01040 } /* Literal.String.Interpol */
+.codehilite .sx { color: #d01040 } /* Literal.String.Other */
+.codehilite .sr { color: #009926 } /* Literal.String.Regex */
+.codehilite .s1 { color: #d01040 } /* Literal.String.Single */
+.codehilite .ss { color: #990073 } /* Literal.String.Symbol */
+.codehilite .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.codehilite .vc { color: #008080 } /* Name.Variable.Class */
+.codehilite .vg { color: #008080 } /* Name.Variable.Global */
+.codehilite .vi { color: #008080 } /* Name.Variable.Instance */
+.codehilite .il { color: #009999 } /* Literal.Number.Integer.Long */

index.html

@@ -9,10 +9,13 @@
   
   <link rel="shortcut icon" href="img/favicon.ico">
   <title>Welcome to the NewPipe Documentaiton. - NewPipe Documentation</title>
+  <!-- local fonts -->
   <link rel="stylesheet" href="./css/local_fonts.css" type="text/css" />
 
   <link rel="stylesheet" href="./css/theme.css" type="text/css" />
   <link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
+  <!-- local code syntax highlighting -->
+  <link rel="stylesheet" href="./css/github.min.css" type="text/css" />
   <link rel="stylesheet" href="./css/highlight.css" type="text/css" />
   
   <script>
@@ -24,7 +27,7 @@
   
   <script src="js/jquery-2.1.1.min.js" defer></script>
   <script src="js/modernizr-2.8.3.min.js" defer></script>
-  <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+  <script src="./js/highlight.min.js"></script>
   <script>hljs.initHighlightingOnLoad();</script> 
   
 </head>
@@ -168,5 +171,5 @@ It focuses on making it possible for the creator of a scraper for a streaming se
 
 <!--
 MkDocs version : 1.0.3
-Build Date UTC : 2018-09-01 13:48:12
+Build Date UTC : 2018-09-08 17:06:35
 -->

sitemap.xml

@@ -2,22 +2,22 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
      <loc>None</loc>
-     <lastmod>2018-09-01</lastmod>
+     <lastmod>2018-09-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-09-01</lastmod>
+     <lastmod>2018-09-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-09-01</lastmod>
+     <lastmod>2018-09-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>None</loc>
-     <lastmod>2018-09-01</lastmod>
+     <lastmod>2018-09-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>