Skip to content

Commit 3b0e077

Browse files
Merge pull request #21 from RedisInsight/ViktarStarastsenka-patch-1
Update README.md
2 parents 2b2697f + 77fdf8a commit 3b0e077

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you
1010

1111
1. [Structure](#Structure)
1212
2. [Examples](#Examples)
13-
3. [Advanced button parameters](#Advanced)
13+
3. [Markdown](#Markdown)
14+
4. [Images](#Images)
15+
5. [Manifest](#Manifest)
16+
6. [Advanced button parameters](#Advanced)
1417

1518
## Structure
1619

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

48+
## Images
49+
Basic [markdown syntax](https://www.markdownguide.org/basic-syntax/#images-1) provides the ability to render images.
50+
51+
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.
52+
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.
53+
54+
Use the following logic to specify a relative path:
55+
56+
- `./` means the current directory;
57+
- `../` means the parent of the current directory.
58+
59+
For example:
60+
61+
```
62+
![RedisInsight Browser screenshot](./_images/aggregations.png)
63+
```
64+
65+
4566
## Manifest
4667

4768
Manifest.json is not required and can be skipped, in the case of missing manifest.json, RedisInsight will:

0 commit comments

Comments
 (0)