Skip to content

Commit fc57bd7

Browse files
committed
added docu for displayContent
1 parent 962e02c commit fc57bd7

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

documentation/Functions.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -360,9 +360,35 @@ display("Step title", [{ "file": "files/description.asciidoc" }, { "content": "T
360360
#### Details
361361
Available attributes in the json objects:
362362

363-
file: Path to a file whose content is to be displayed in the katacoda step (e.g. .asciidoc or .txt file). The file should be following the formating of asciidoc files.
364-
content: Plain text to be displayed in the katacoda step. This Text should be following the formating of asciidoc files.
365-
image: Path to an image to be displayed in the katacoda step.
363+
1. file: Path to a file whose content is to be displayed in the katacoda step (e.g. .asciidoc or .txt file). The file should be following the formating of asciidoc files.
364+
2. content: Plain text to be displayed in the katacoda step. This Text should be following the formating of asciidoc files.
365+
3. image: Path to an image to be displayed in the katacoda step.
366+
367+
#### Formatting rules for content and .asciidoc or .txt files.
368+
* You can add headers to structure your text. The generated headers are shown in the examples below. The headers should fit into the overall structure of the generated wiki so level 1 header arent allowed, but the other header can be used at your judgement.
369+
* A list always needs an empty newline between the last row and the list.
370+
* Use asciidoc style of links
371+
372+
#### examples
373+
```
374+
Existing header structure
375+
= Level 1: tutorial title
376+
== Level 2: subtitle
377+
=== Level 3: prerequisites and learning goals
378+
== Level 2: steptitle
379+
=== Level 3: titles from functions
380+
==== Level 4: subtitles from functions
381+
== Level 2: conclusion
382+
383+
List:
384+
This an unordered List (The empty line is necessary)
385+
386+
* First Item
387+
* Second Item
388+
389+
Link:
390+
The tutorials repository can be found https://github.com/devonfw-tutorials/tutorials/issues[here].
391+
```
366392

367393
***
368394

0 commit comments

Comments
 (0)