Skip to content

GRA0007/obsidian-advanced-images

Repository files navigation

Obsidian Advanced Images

GitHub Release Checks Obsidian

Advanced image toolkit for Obsidian!

Warning

This project is in alpha and under development. Use the BRAT plugin to install.

Features

Captions

Display image alt text as a caption beneath the image.

To use, add an alt text like ![[image.jpg|My cool caption]] or ![My cool caption](test.jpg).

If you want to display the file name, you can use a % symbol instead: ![[image.jpg|%]].

Layout

Display images side-by-side by placing them next to each other in the source. The following will show two images on one row, and then three on the next row:

![[one.jpg]]
![[two.jpg]]

![[three.jpg]]
![[four.jpg]]
![[five.jpg]]

Roadmap

Tip

Check out the changelog to see what's already been implemented.

💬 Captions

  • Render markdown inside image captions
  • Enable captions on file and PDF embeds

🍱 Layout

  • Display classic markdown (![](test.jpg)) images side-by-side
  • Display file and PDF embeds side-by-side
  • Resize images by dragging from a corner
  • Display images inline with text (float left/right)

🎞️ Gallery

  • Simple grid image gallery
  • Masonry image gallery
  • Image carousel

🎚️ Optimization

  • Dashboard to compress/optimize images in your vault
  • Automatically compress images when added

Development

This project uses Biome and Yarn for linting/formatting and package management. Run yarn dev to build on changes.

Prior Art

Thank you to the incredible developers and their work which inspired this plugin:

About

Advanced image toolkit for Obsidian!

Resources

License

Stars

4 stars

Watchers

1 watching

Forks

Sponsor this project

  •  

Packages

 
 
 

Contributors