You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/Functions.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -352,20 +352,20 @@ If the tutorial should be tested on the console environment, you have to specify
352
352
### displayContent <aname="displayContent"></a>
353
353
#### parameter
354
354
1. The title of the step.
355
-
2. An array of json objects with files, content, or images to be rendered within the katacoda step. 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!
355
+
2. An array of json objects with files, content, or images to be rendered within the Katacoda step. 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!
356
356
3. (Optional) Path to the current directory where the user is located (relative to the workspace directory). Only needed if the directory is changed within this step.
357
357
#### example
358
358
display("Step title", [{ "file": "files/description.asciidoc" }, { "content": "This is just plain content." }, { "image": "files/image.png" }])
359
359
360
360
#### Details
361
361
Available attributes in the json objects:
362
362
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.
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
366
367
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.
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 are not allowed, but the other header can be used at your judgement.
369
369
* A list always needs an empty newline between the last row and the list.
Copy file name to clipboardExpand all lines: runners/wikiConsole/templates/adaptTemplates.asciidoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<%if(title){%>== <%- title; %>
2
2
<%if(text){%><%- text; %><%}%><%}else{%>
3
3
4
-
=== Generate CobiGen Templates
4
+
=== Generate CobiGen templates
5
5
<%if(text){%><%- text; %><%}%>
6
6
7
7
How to use CobiGen, to generate templates for the following code generation.
@@ -12,7 +12,7 @@ More information about CobiGen on https://devonfw.com/website/pages/docs/master-
12
12
13
13
* An installed devonfw distribution is needed. To execute the CobiGen CLI, you have to install the devonfw IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw IDE] documentation to install the same.
14
14
15
-
==== Generate CobiGen Templates with CobiGen CLI
15
+
==== Generate CobiGen templates with CobiGen CLI
16
16
17
17
First open a command prompt in your current workspace. You should be inside your devonfw directory, if not change your directory to *<%= devonPath;%>*.
18
18
Run the CobiGen command `devon cobigen adapt-templates`
Copy file name to clipboardExpand all lines: runners/wikiConsole/templates/createFolder.asciidoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
<%if(title){%>== <%- title; %>
2
2
<%if(text){%><%- text; %><%}%><%}else{%>
3
3
4
-
=== Create Folder
4
+
=== Create folder
5
5
<%if(text){%><%- text; %><%}%><%}%>
6
6
7
-
==== Creating a new Folder
7
+
==== Creating a new folder
8
8
9
9
A folder can be created either from within an IDE like VSCode or Eclipse by simply right clicking in the file explorer and creating a new folder. Another approach is to use the Terminal.
@@ -11,7 +11,7 @@ More information about CobiGen on https://devonfw.com/website/pages/docs/master-
11
11
==== Prerequisites
12
12
An installed devonfw distribution is needed. To execute CobiGen in Eclipse IDE, you have to install the devonfw IDE with the Eclipse IDE first. Follow the https://devonfw.com/website/pages/docs/devonfw-ide-introduction.asciidoc.html[devonfw-ide] documentation to install the same.
13
13
14
-
==== Generate CobiGen Templates with Eclipse IDE
14
+
==== Generate CobiGen templates with Eclipse IDE
15
15
16
16
First, open Eclipse IDE, and if your file explorer is empty load any file, create a file, or project into Eclipse.
17
17
Right-click any file in the file explorer to open a dropdown menu where you can select CobiGen and an additional menu opens. Select *Adapt Templates...* and CobiGen starts generating a new template folder. CobiGen gives you a warning that existing templates will be overridden in your current workspace, you can confirm to continue. If the folder is already existing CobiGen will inform you, that for updating your templates you have to use the *Update Templates...* functionality else CobiGen will create a folder and download the latest template to use it. You can confirm the messages with *OK* or *Update* and the CobiGen templates folder is imported successfully.
0 commit comments