newpipe-documentation/index.html

203 lines
6.8 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Welcome to NewPipe. - 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" />
<link rel="stylesheet" href="./css/theme_child.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>
// Current page data
var mkdocs_page_name = "Welcome to NewPipe.";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = null;
</script>
<script src="js/jquery-2.1.1.min.js" defer></script>
<script src="js/modernizr-2.8.3.min.js" defer></script>
<script src="./js/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> NewPipe Documentation</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current">
<a class="current" href=".">Welcome to NewPipe.</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#welcome-to-newpipe">Welcome to NewPipe.</a></li>
<ul>
<li><a class="toctree-l3" href="#introduction">Introduction</a></li>
</ul>
</ul>
</li>
<li class="toctree-l1">
<a class="" href="00_Prepare_everything/">Before You Start</a>
</li>
<li class="toctree-l1">
<a class="" href="01_Concept_of_the_extractor/">Concept of the Extractor</a>
</li>
<li class="toctree-l1">
<a class="" href="02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
</li>
<li class="toctree-l1">
<a class="" href="03_Implement_a_service/">Implementing a Service</a>
</li>
<li class="toctree-l1">
<a class="" href="04_Run_changes_in_App/">Testing Your Changes in the App</a>
</li>
<li class="toctree-l1">
<a class="" href="05_releasing/">Releasing a New NewPipe Version</a>
</li>
<li class="toctree-l1">
<a class="" href="06_documentation/">About This Documentation</a>
</li>
<li class="toctree-l1">
<a class="" href="07_maintainers_view/">Maintainers' Section</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">NewPipe Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".">Docs</a> &raquo;</li>
<li>Welcome to NewPipe.</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="welcome-to-newpipe">Welcome to NewPipe.</h1>
<p><img width=150 src="https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png"/></p>
<p>This site is/should be a beginner friendly tutorial and documentation for people who want to use or write services for the <a href="https://github.com/TeamNewPipe/NewPipeExtractor">NewPipe Extractor</a>. However, it also contains several notes about how to maintain NewPipe.
It is an addition to our auto generated <a href="https://teamnewpipe.github.io/NewPipeExtractor/javadoc/">jdoc documentation</a>.</p>
<p>Please be aware that it is in its early stages, so help and <a href="https://github.com/TeamNewPipe/documentation/issues">feedback</a> is always appreciated :D</p>
<h2 id="introduction">Introduction</h2>
<p>The NewPipeExtractor is a Java framework for scraping video platform websites in a way that they can be accessed like a normal API. The extractor is the core of the popular YouTube and streaming app <a href="https://newpipe.schabi.org">NewPipe</a> for Android. It is entirely independent from said platforms and also available for additional platforms as well. </p>
<p>The beauty behind this framework is that it takes care of the extracting process, error handling etc. so you can focus on what is important: Scraping the website.
It focuses on making it possible for the creator of a scraper for a streaming service to create the best outcome with the least amount of written code.</p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="00_Prepare_everything/" class="btn btn-neutral float-right" title="Before You Start">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<span style="margin-left: 15px"><a href="00_Prepare_everything/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script>
</body>
</html>
<!--
MkDocs version : 1.0.4
Build Date UTC : 2020-01-19 09:24:21
-->