Go to file
TobiGr 2e223b9ad9 Add getting started section for the extractor
TODO: rename all docs to place getting started at the beginning.
2021-12-22 11:23:58 +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 Add getting started section for the extractor 2021-12-22 11:23:58 +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 Spelling in README.md 2018-12-12 13:09:41 -04: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

travis_build_state

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

GNU GPLv3 Image

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.