Skip to content

Commit 70a9aff

Browse files
author
Roman Sergeenko
committed
Merge branch 'main' into feature/RI-4580
# Conflicts: # README.md
2 parents 05839d1 + 3b0e077 commit 70a9aff

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
88

99
## Navigation
1010

11-
1. [Structure](#structure)
12-
2. [Examples](#examples)
13-
3. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
14-
4. [Advanced button parameters](#advanced)
11+
1. [Structure](#Structure)
12+
2. [Examples](#Examples)
13+
3. [Markdown](#Markdown)
14+
4. [Images](#Images)
15+
5. [Manifest](#Manifest)
16+
6. [Bulk Upload From Tutorials](#bulk-upload-from-tutorials)
17+
7. [Advanced button parameters](#Advanced)
1518

1619
## Structure
1720

@@ -43,6 +46,24 @@ If you would like to add a button that will insert Redis commands to the Workben
4346
```
4447
````
4548

49+
## Images
50+
Basic [markdown syntax](https://www.markdownguide.org/basic-syntax/#images-1) provides the ability to render images.
51+
52+
To render images, you need to provide either an external URL to these images or a relative path to a folder inside of your tutorials.
53+
The folder with images can have any name, but it is recommended to start it with an underscore (_) or a dot (.) to avoid displaying it in Workbench when the [manifest](#Manifest) is automatically generated.
54+
55+
Use the following logic to specify a relative path:
56+
57+
- `./` means the current directory;
58+
- `../` means the parent of the current directory.
59+
60+
For example:
61+
62+
```
63+
![RedisInsight Browser screenshot](./_images/aggregations.png)
64+
```
65+
66+
4667
## Manifest
4768

4869
Manifest.json is not required and can be skipped, in the case of missing manifest.json, RedisInsight will:
@@ -179,4 +200,3 @@ redis:[results=single;pipeline=4]
179200
redis:[results=group;mode=ascii]
180201
redis:[auto=true;pipeline=8;mode=raw;results=single;]
181202
```
182-

0 commit comments

Comments
 (0)