Skip to content

Commit 314fb63

Browse files
authored
Updated document
1 parent 09d7beb commit 314fb63

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

documentation/Functions.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -565,22 +565,14 @@ Note: The title should never be empty and it is of type string.
565565
2. Second parameter:
566566
- **Required**
567567
- **Type**- Array of JSON objects with files, content, or images to be rendered within the Katacoda step.
568-
- **Description**-The use for this function is to display an image and some descriptive text. No Katacoda syntax is allowed in the files or the content!
568+
- **Description**-This function consists of three attributes. The use for this function is to display an image and some descriptive text. No Katacoda syntax is allowed in the files or the content!
569+
* 1st attribute i.e. "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.
570+
* 2nd attribute i.e. "content": Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
571+
* 3rd attribute i.e. "image": Path to an image to be displayed in the Katacoda step. It should be placed under subfolder of the playbook directory.
569572

570573
#### example
571574
displayContent("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
572575

573-
#### Details
574-
You can use 3 attributes in the JSON objects array in second parameter:
575-
576-
Second-parameter = [{1st attribute}, {2nd attribute}, {3rd attribute}]
577-
578-
* 1st attribute i.e. "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.
579-
580-
* 2nd attribute i.e. "content": Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files.
581-
582-
* 3rd attribute i.e. "image": Path to an image to be displayed in the Katacoda step. It should be placed under subfolder of the playbook directory.
583-
584576
#### Formatting rules for content and .asciidoc or .txt files.
585577
* 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 are not allowed, but the other header can be used at your judgement.
586578
* A list always needs an empty newline between the last row and the list.

0 commit comments

Comments
 (0)