From 9410de6c807ccc39170208ae49dacf0dd5434c59 Mon Sep 17 00:00:00 2001 From: Christian Schabesberger Date: Fri, 16 Nov 2018 19:23:01 +0100 Subject: [PATCH] fix image paths --- docs/00_Prepare_everything.md | 2 +- docs/01_Concept_of_the_extractor.md | 2 +- docs/04_Run_changes_in_App.md | 5 +++-- docs/index.md | 3 +++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/00_Prepare_everything.md b/docs/00_Prepare_everything.md index f439886..161cb24 100644 --- a/docs/00_Prepare_everything.md +++ b/docs/00_Prepare_everything.md @@ -45,7 +45,7 @@ If all the checks are green you did everything right, and you are good to go to Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle". As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run. -![tests passed on idea](/img/prepare_tests_passed.png) +![tests passed on idea](img/prepare_tests_passed.png) # Inclusion criteria for services diff --git a/docs/01_Concept_of_the_extractor.md b/docs/01_Concept_of_the_extractor.md index 747d4e9..aea7bc0 100644 --- a/docs/01_Concept_of_the_extractor.md +++ b/docs/01_Concept_of_the_extractor.md @@ -60,7 +60,7 @@ Sometimes information can be represented as a list. In NewPipe a list is represe A InfoItemCollector will collect and assemble a list of [InfoItem](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItem.html). For each item that should be extracted a new Extractor must be created, and given to the InfoItemCollector via [commit()](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/InfoItemsCollector.html#commit-E-). -![InfoItemsCollector_objectdiagram.svg](/img/InfoItemsCollector_objectdiagram.svg) +![InfoItemsCollector_objectdiagram.svg](img/InfoItemsCollector_objectdiagram.svg) If you are implementing a list for your service you need to extend InfoItem containing the extracted information, and implement an [InfoItemExtractor](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/org/schabi/newpipe/extractor/Extractor.html) diff --git a/docs/04_Run_changes_in_App.md b/docs/04_Run_changes_in_App.md index 1749676..9fa765f 100644 --- a/docs/04_Run_changes_in_App.md +++ b/docs/04_Run_changes_in_App.md @@ -40,10 +40,11 @@ Your browser does not support the video tag. If everything synced well then you should only see a screen with OK signs. Now you can go on an compile and run NewPipe with the new extractor. -![image_sync_ok](/img/sync_ok.png) + +![image_sync_ok](img/sync_ok.png) ### Trouble shoot If something went wrong on jitpack site, you can check their build log, by selecting the commit you tried to build and click on that little paper symbol next to the `GET IT` button. If it is red it already shows that the build failed. -![jitpack failed to build](/img/jitpack_fail.png) +![jitpack failed to build](img/jitpack_fail.png) diff --git a/docs/index.md b/docs/index.md index 476176d..b81427b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,8 @@ # Welcome to the NewPipe Documentation. + + + This side is/should be a beginner friendly tutorial and documentation for people who want to use, or write services for the [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor). It is an addition to our auto generated [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/).