Merge pull request #325 from GuentherJulian/feature/copyImages

copy images folder to output directory

Author: SchettlerKoehler

documentation/Structure.md

@@ -11,8 +11,12 @@
     |-- tutorials
         |-- [playbook-name]
             /--index.asciidoc
+            |-- images
+                /--image.jpg
+            
 
-Write your own tutorials in "./tutorials/[playbook-name]/index.asciidoc".
+
+Write your own tutorials in "./tutorials/[playbook-name]/index.asciidoc". Images must be saved in a folder called `images`.
 You will find all the details in the tutorials [Developement](https://github.com/devonfw-tutorials/tutorials/wiki/Development) page.
 
 

documentation/Tutorials.md

@@ -94,6 +94,12 @@ functionName2(parameters)
 --
 ```
 
+To display images within a step, you can use either the [displayContent](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Functions#displayContent) function or the following syntax in the index.asciidoc file:
+```
+![alternative text](./assets/image.jpg)
+```
+The image must be in a folder called `images` in the folder of the playbook (see [Structure](https://github.com/devonfw-tutorials/tutorial-compiler/wiki/Structure)).
+
 You can also add an optional conclusion text, which is shown on completion of the tutorial. Use this to summarize the important content of the tutorial, to point out what to learn next or to mention other useful informations.
 
 To do that, you have to provide the conclusion at the end of the tutorial (after the last step) surrounded by ```====```.
@@ -115,6 +121,7 @@ Description of the tutorial
 ====
 
 The explanation for the step 1
+![alternative text](./assets/image.jpg)
 [step]
 --
 functionName1(parameters)

runners/katacoda/index.ts

@@ -73,6 +73,11 @@ export class Katacoda extends Runner {
         this.createFolder(path.join(this.outputPathTutorial, "assets", "setup"), true);
         this.writeSetupFile(path.join(this.outputPathTutorial, "assets", "setup", "setup.txt"))
 
+        let imageDirectory = path.join(this.playbookPath, "images");
+        if(fs.existsSync(imageDirectory)) {
+            this.assetManager.registerDirectory(imageDirectory, "", "", true);
+        }
+
         // copy all assets from temp/setup in assets folder
         this.assetManager.registerDirectory(path.join(this.tempPathTutorial, "setup"), "setup", "/root/setup", true);
         this.assetManager.copyAssets();
@@ -355,7 +360,6 @@ export class Katacoda extends Runner {
                 fs.appendFileSync(tempFile, fs.readFileSync(path.join(this.playbookPath, param.file), "utf-8"));
             } else if (param.image) {
                 let image = path.join(this.playbookPath, param.image);
-                this.assetManager.registerFile(image, path.basename(image), "", true);
                 fs.appendFileSync(tempFile, "![" + path.basename(image) + "](./assets/" + path.basename(image) + ")");
             }
             fs.appendFileSync(tempFile, "\n\n");