mirror of https://github.com/TeamNewPipe/documentation

Go to file

Tobi ed03f04674 Merge pull request #49 from TeamNewPipe/release-instructions-jdk21-fdroiddata Update release instructions to ensure JDK 21 and explain F-Droid MR		2024-12-02 23:49:40 +01:00
.github/workflows	Test if docs can build in CI	2021-11-28 22:51:10 +01:00
assets	add description about how to do hotfixes	2019-02-21 15:21:38 +01:00
ci	Test if docs can build in CI	2021-11-28 22:51:10 +01:00
docs	Update release instructions to ensure JDK 21 and explain F-Droid MR	2024-12-02 16:07:44 +01:00
theme	Fix menu burger icon in navbar (mobile devices)	2019-04-07 19:33:50 +02:00
.gitignore	Ignore temporary editor backups	2021-11-28 21:58:32 +01:00
LICENSE	add Readme and license foo	2018-02-20 23:13:34 +01:00
README.md	Update repository link.	2022-02-23 09:47:29 +01:00
copyright	add Readme and license foo	2018-02-20 23:13:34 +01:00
linkcheck.py	Fix most errors from linkcheck	2021-11-28 21:01:59 +01:00
mkdocs.yml	Clarify that this repo contains docs for developers	2021-11-28 23:20:19 +01:00

README.md

NewPipe Tutorial

This is the tutorial for the NewPipeExtractor. It is for those who want to write their own service, or use NewPipeExtractor in their own projects.

This tutorial and the documentation are in an early state. So feedback is always welcome :D

The tutorial is created using mkdocs. You can test and host it your self by running mkdocs serve in the root directory of this project. If you want to deploy your changes and you are one of the maintainers you can run mkdocs gh-deploy && git push.

License

NewPipe is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.