Skip to content

Commit d831316

Browse files
changed documentation
1 parent ea6a825 commit d831316

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

documentation/Structure.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,14 @@
1111
|-- tutorials
1212
|-- [playbook-name]
1313
/--index.asciidoc
14+
|-- images
15+
/--image.png
16+
17+
1418

1519
Write your own tutorials in "./tutorials/[playbook-name]/index.asciidoc".
1620
You will find all the details in the tutorials [Developement](https://github.com/devonfw-tutorials/tutorials/wiki/Development) page.
21+
The images must be saved in a folder called `images`.
1722

1823

1924
# File system of the "tutorial-compiler" - repository

documentation/Tutorials.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ functionName2(parameters)
9494
--
9595
```
9696

97+
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:
98+
```
99+
![alternative text](./assets/image.jpg)
100+
```
101+
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)).
102+
97103
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.
98104

99105
To do that, you have to provide the conclusion at the end of the tutorial (after the last step) surrounded by ```====```.

0 commit comments

Comments
 (0)