Convert a image in your note to text.
  • TypeScript 95.5%
  • JavaScript 4.5%
Find a file
Dario Baumberger 27edeb5989
Merge pull request #7 from dario-baumberger/6-feature-request-ocred-text-at-the-image-tag
6 feature request ocred text at the image tag
2026-04-30 12:54:05 +02:00
.github cicd: add lint step 2026-04-21 20:57:32 +02:00
demo added demo 2024-01-31 21:57:14 +01:00
src feat: implement alt text functionality 2026-04-21 22:10:21 +02:00
tests feat: implement alt text functionality 2026-04-21 22:10:21 +02:00
.editorconfig Initial commit 2024-01-24 00:16:07 +01:00
.eslintignore Initial commit 2024-01-24 00:16:07 +01:00
.eslintrc added functionality 2024-01-31 21:13:54 +01:00
.gitignore chaged gitignore coverage pattern 2024-02-27 22:43:08 +01:00
.npmrc Initial commit 2024-01-24 00:16:07 +01:00
.prettierrc added functionality 2024-01-31 21:13:54 +01:00
esbuild.config.mjs prettier 2024-02-27 22:41:17 +01:00
LICENCE added functionality 2024-01-31 21:13:54 +01:00
manifest.json chore: update to version 1.0.5 2026-04-30 12:53:01 +02:00
package-lock.json chore: update npm packages 2026-04-21 20:40:05 +02:00
package.json chore: update to version 1.0.5 2026-04-30 12:53:01 +02:00
README.md docs: change image 2026-04-23 14:02:42 +02:00
tsconfig.json added functionality 2024-01-31 21:13:54 +01:00
version-bump.mjs docs: add new line to manifest and version 2025-09-25 14:44:42 +02:00
versions.json chore: update to version 1.0.5 2026-04-30 12:53:01 +02:00

Build and Test Obsidian Downloads GitHub stars License: MIT

Obsidian Image to text

Recognize Text on images in your notes. Select the image and run the command. The recognized text will be appended to your image or will replace your image - depending on the command

Commands

Command Description
Replace selection Replace your image with the recognized text. Recognize text based on the language defined in settings
Replace selection - custom language Replace your image with the recognized text. Recognize text based on custom selection
Append selection Append the recognized text to your image. Recognize text based on language defined in settings
Append selection - custom language Append the recognized text to your image. Recognize text based on custom selection
Insert as alt text Insert the recognized text as alt text to your image. Recognize text based on language defined in settings. Note: This will overwrite any existing alt text
Insert as alt text - custom language Insert the recognized text as alt text to your image. Recognize text based on custom selection. Note: This will overwrite any existing alt text

Example

Lorem ipsum Animated

Supported Image Types

  • .jpg
  • .jpeg
  • .png
  • .gif
  • .bmp
  • .pbm
  • .webp

Supported Markup

Format Example Description
Obsidian Image ![[example.png]] Obsidian image tag
Obsidian Image including size ![[example.png|300]] Obsidian image tag including size. Size is preserved when using "Insert as alt text"
Markdown Image ![Image](https://www.example.com/example.png) Markdown image tag
URL https://www.example.com/example.png URL to an image
img Tag <img src="https://www.example.com/example.png" /> Img tag with a valid src attribute

Installation

Community Plugin

  • Follow this link Obsidian Plugin
  • Or open Obsidian Settings, go to Community Plugins, browse "Image to Text OCR" click install and activate.

Manually installing the plugin

  • Go to the latest Releases
  • Download main.js, manifest.json
  • save into your vault VaultFolder/.obsidian/plugins/obsidian-image-to-text-ocr/

Settings

Name Description
Content language Select language to recognize. Default is Englisch. If images contain special characters, changing the language may perform better results
Enable debug logging If enabled, more will be logged in the console.

Ressources

This plugin uses tesseract.js to recognize text.

Contribution

  • Feel free to open an issue if you miss something
  • Feel free to open a Pull request to implement a feature
    • Please extend tests if you add logic