Skip to content

Commit 5a0dafc

Browse files
committed
tag documentation
1 parent 25b78b9 commit 5a0dafc

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

documentation/Tutorials.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Every tutorial has three main parts
99
* at least one step
1010
Additionally, there are optional parts
1111
* a subtitle
12+
* tags
1213
* a conclusion of the tutorial. This will be shown at the last page and can be used to summarize the learned, to foreshadow the next steps on the learning path or to mention useful sources.
1314

1415
The tutorials are written in asciidoc files.
@@ -100,6 +101,18 @@ To display images within a step, you can use either the [displayContent](https:/
100101
```
101102
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)).
102103

104+
There is the option to add tags to your tutorials. To do that, you have to add the following syntax after the title or if you have specified a subtitle, after the subtitle.
105+
106+
````
107+
= Title
108+
== Subtitle
109+
[tags]
110+
--
111+
tagType=tag0;tag1
112+
tagType=tag0;tag1;tag2
113+
--
114+
```
115+
103116
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.
104117
105118
To do that, you have to provide the conclusion at the end of the tutorial (after the last step) surrounded by ```====```.
@@ -116,6 +129,11 @@ These blocks are combined to a complete tutorial.
116129
```
117130
= Title
118131
== Subtitle
132+
[tags]
133+
--
134+
tagType=tag0;tag1
135+
tagType=tag0;tag1;tag2
136+
--
119137
====
120138
Description of the tutorial
121139
====

0 commit comments

Comments
 (0)