maradotwebp_obsidian-avatar/README.md
2023-03-18 19:57:40 +01:00

29 lines
813 B
Markdown

# Obsidian Avatar
This plugin provides you with a component that will display a small image with some accompanying text. That's it.
![Preview Mode](./docs/avatar_preview.PNG)
To use, insert the following snippet into your markdown.
````
```avatar
```
````
## Editing the picture / description
**In source mode**, you can edit the codeblock directly:
````
```avatar
image: your-image-here.png
description: This will be displayed as the description!
```
````
**In live preview mode**, click on the image to change it *(then either select one from your vault, or paste in a URL to a picture online)*, or edit the description by clicking on it *(Don't forget to click the button to save your changes!)*
![Edit Mode](./docs/avatar_edit.PNG)
The description editor supports all markdown features of Obsidian.