obsidian-plugin/maradotwebp_obsidian-avatar
1
0
Fork 0
mirror of https://github.com/maradotwebp/obsidian-avatar.git synced 2026-07-22 07:30:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
31 commits 1 branch 9 tags 410 KiB
TypeScript 42.4%
Svelte 41.3%
JavaScript 14.1%
CSS 2.2%
Find a file
froehlichA 410fa34cd0 release version 1.0.5
2023-03-22 22:43:25 +01:00
.github/workflows add github workflow 2023-03-18 20:13:08 +01:00
docs correct readme 2023-03-18 19:55:03 +01:00
src remove settings 2023-03-22 22:42:43 +01:00
.editorconfig Initial commit 2023-03-18 16:51:54 +01:00
.eslintignore Initial commit 2023-03-18 16:51:54 +01:00
.eslintrc Initial commit 2023-03-18 16:51:54 +01:00
.gitignore Initial commit 2023-03-18 16:51:54 +01:00
.npmrc Initial commit 2023-03-18 16:51:54 +01:00
esbuild.config.mjs add support for svelte 2023-03-18 17:04:28 +01:00
LICENSE.md add license 2023-03-18 20:35:47 +01:00
main.ts implement AvatarView.svelte 2023-03-18 18:01:29 +01:00
manifest.json release version 1.0.5 2023-03-22 22:43:25 +01:00
package-lock.json release version 1.0.5 2023-03-22 22:43:25 +01:00
package.json release version 1.0.5 2023-03-22 22:43:25 +01:00
README.md add installation instructions for the plugin 2023-03-18 20:30:47 +01:00
styles.css namespace global css 2023-03-18 19:22:41 +01:00
tsconfig.json add support for svelte 2023-03-18 17:04:28 +01:00
version-bump.mjs Initial commit 2023-03-18 16:51:54 +01:00
versions.json release version 1.0.5 2023-03-22 22:43:25 +01:00

README.md

Obsidian Avatar

This plugin provides you with a component that will display a small image with some accompanying text. That's it.

Preview Mode

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

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
  5. 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: <vault>/.obsidian/plugins
  3. Reload Obsidian