Image to text OCR

approved

by Dario Baumberger

Convert a image in your note to text.

15 stars4,771 downloadsUpdated 6mo agoMIT
View on GitHub

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

CommandDescription
Replace selectionReplace your image with the recognized text. Recognize text based on the language defined in settings
Replace selection - custom languageReplace your image with the recognized text. Recognize text based on custom selection
Append selectionAppend the recognized text to your image. Recognize text based on language defined in settings
Append selection - custom languageAppend the recognized text to your image. Recognize text based on custom selection

Example

Lorem ipsum Animated

Supported Image Types

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

Supported Markup

FormatExampleDescription
Obsidian Image![[example.png]]Obsidian image tag
Obsidian Image including size![[example.png|300]]Obsidian image tag including size
Markdown Image![Image](https://www.example.com/example.png)Markdown image tag
URLhttps://www.example.com/example.pngURL 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

NameDescription
Content languageSelect language to recognize. Default is Englisch. If images contain special characters, changing the language may perform better results
Enable debug loggingIf 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

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.