README file from
Github中文 | English
Note Image Manager
Note Image Manager is an image-management plugin for Obsidian. It keeps image import, naming, conversion, compression, lightweight editing, gallery browsing, and recovery in one controlled workflow.
Current version: 4.0.6
Minimum Obsidian version: 1.13.1
Release target: desktop plugin, with isDesktopOnly set to true in manifest.json
Highlights
- Automatically handles pasted images, stores them in a configurable folder, and generates file names from variable templates.
- Supports note-scoped managed folders such as
./assets/${noteFileName}. - Imports image sources from
URL,file://, anddata:image/...;base64,...into the local vault and rewrites them as local image links. - Runs external-image import, format conversion, compression, link cleanup, and orphan-image cleanup against the current note, current folder, or whole vault.
- Supports Obsidian Wiki links and standard Markdown links, with encoded, readable-wrapped, and automatic path-output strategies.
- Adds image context-menu actions for copy, compress, convert, rotate, flip, and drag-to-crop.
- Provides current-image, note-level, and folder-level galleries with filtering, sorting, and grid / list views.
- Persists recovery transactions for image and Markdown changes, with undo / redo support for recent Note Image Manager operations.
- Supports Simplified Chinese and English in the settings page and feature-status panel, with Chinese as the default.
Installation
Community Marketplace
After marketplace approval, install it from Settings -> Community plugins by searching for Note Image Manager.
Manual Install
- Open Releases.
- Download
manifest.json,main.js, andstyles.cssfor the target version, or downloadnote-image-manager.zip. - Place the files in your vault under
.obsidian/plugins/note-image-manager/. - Enable Note Image Manager in Settings -> Community plugins.
Source And Documentation
The main branch keeps the release surface small: README files, release notes, plugin install artifacts, version metadata, and the GitHub Pages website. Full source, tests, development configuration, and detailed documentation live on the develop branch.
| Goal | Link |
|---|---|
| Browse the full documentation set | Docs Index |
| Learn commands, settings, galleries, diagnostic logging, and recovery | User Guide |
| Configure naming and folder variables | Variable Reference |
| Review source code and tests | develop branch |
| Read version history | Changelog |
Disclosure And Limits
- The plugin does not collect telemetry, does not include ads, and does not silently upload vault content.
- Remote images are downloaded only when the relevant external-image import flow is enabled or explicitly triggered by the user.
file://local-image import runs only when the user explicitly pastes or imports such sources.- Formats such as
GIF,SVG,TIFF,HEIC, andAVIFuse layered compatibility: they may be recognized, imported, or accepted as conversion input, but that does not guarantee every in-place edit or compression path is stable. - Compression history and recovery snapshots are stored under
.obsidian/plugins/note-image-manager/so the plugin can avoid duplicate compression and support undo / redo. - Vault-wide conversion, compression, and orphan-image cleanup commands require confirmation before running.
Acknowledgements
This project is built on the Obsidian plugin API and is developed with TypeScript, esbuild, ESLint, and Vitest.
Image handling and product boundaries were informed by parts of piexifjs, Custom Attachment Location, and obsidian-image-converter. Mentioning a reference project is not a promise of full compatibility.
Support The Project
If Note Image Manager saves you time managing images, you can support ongoing maintenance through WeChat Pay or Alipay: