Skip to content

Update README.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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