Skip to content

Commit

Permalink
Merge pull request #21 from RedisInsight/ViktarStarastsenka-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
ViktarStarastsenka authored May 31, 2023
2 parents 2b2697f + 77fdf8a commit 3b0e077
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ If you want to share your own tutorials - add the `redis-tutorials` label to you

1. [Structure](#Structure)
2. [Examples](#Examples)
3. [Advanced button parameters](#Advanced)
3. [Markdown](#Markdown)
4. [Images](#Images)
5. [Manifest](#Manifest)
6. [Advanced button parameters](#Advanced)

## Structure

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

## Images
Basic [markdown syntax](https://www.markdownguide.org/basic-syntax/#images-1) provides the ability to render images.

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.
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.

Use the following logic to specify a relative path:

- `./` means the current directory;
- `../` means the parent of the current directory.

For example:

```
![RedisInsight Browser screenshot](./_images/aggregations.png)
```


## Manifest

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

0 comments on commit 3b0e077

Please sign in to comment.