Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dario-baumberger/obsidian-image-to-text-ocr

Convert a image in your note to text.
https://github.com/dario-baumberger/obsidian-image-to-text-ocr

md obsidian obsidian-md obsidian-plugin ocr tesseractjs

Last synced: about 1 month ago
JSON representation

Convert a image in your note to text.

Host: GitHub
URL: https://github.com/dario-baumberger/obsidian-image-to-text-ocr
Owner: dario-baumberger
License: mit
Created: 2024-01-23T23:16:05.000Z (10 months ago)
Default Branch: master
Last Pushed: 2024-09-01T13:29:25.000Z (2 months ago)
Last Synced: 2024-09-30T00:43:35.338Z (about 2 months ago)
Topics: md, obsidian, obsidian-md, obsidian-plugin, ocr, tesseractjs
Language: TypeScript
Homepage:
Size: 2.09 MB
Stars: 8
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        [![Build and Test](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/actions/workflows/build.yml/badge.svg)](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/actions/workflows/build.yml)

[![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?color=7e6ad6&labelColor=34208c&label=Obsidian%20Downloads&query=$['image-to-text-ocr'].downloads&url=https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugin-stats.json&)](obsidian://show-plugin?id=image-to-text-ocr)

![GitHub stars](https://img.shields.io/github/stars/dario-baumberger/obsidian-image-to-text-ocr?style=flat)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/blob/master/LICENCE)

# 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                    |

## Example

![Lorem ipsum Animated](./demo/loremipsum.gif)

## 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  |

| 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 tag with a valid src attribute |

## Installation

### Community Plugin

-   Follow this link [Obsidian Plugin](https://obsidian.md/plugins?id=image-to-text-ocr)

-   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](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/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](https://github.com/naptha/tesseract.js/) to recognize text.

## Contribution

-   Feel free to [open an issue](https://github.com/dario-baumberger/obsidian-image-to-text-ocr/issues) if you miss something

-   Feel free to open a Pull request to implement a feature

    -   Please extend tests if you add logic