https://github.com/maradotwebp/obsidian-avatar

An obsidian plugin for displaying an avatar image in front of your notes.
https://github.com/maradotwebp/obsidian-avatar

obsidian obsidian-md obsidian-plugin

Last synced: about 2 months ago
JSON representation

An obsidian plugin for displaying an avatar image in front of your notes.

• Host: GitHub
• URL: https://github.com/maradotwebp/obsidian-avatar
• Owner: maradotwebp
• License: mit
• Created: 2023-03-18T15:51:52.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-22T21:44:05.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T06:24:59.564Z (2 months ago)
• Topics: obsidian, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 486 KB
• Stars: 25
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

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

## Installation

### Using Obsidian

1. Open Obsidian

2. Open `Settings` -> `Community Plugins`

3. Click on `Turn on Community plugins` if prompted

4. Click on `Browse`, and search for `Avatar`

6. Install & enable the plugin

### Manual installation

1. Download the latest release .zip from the `Releases` section of this Github repository

2. Extract the .zip to your vault's plugin folder: `/.obsidian/plugins`

3. Reload Obsidian