https://github.com/gapmiss/croppie-for-obsidian

Image cropping plugin for Obsidian.md
https://github.com/gapmiss/croppie-for-obsidian

croppie image-cropper obsidian obsidian-md obsidian-plugin

Last synced: 2 days ago
JSON representation

Image cropping plugin for Obsidian.md

• Host: GitHub
• URL: https://github.com/gapmiss/croppie-for-obsidian
• Owner: gapmiss
• License: mit
• Created: 2023-08-08T11:00:02.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-18T20:39:35.000Z (12 months ago)
• Last Synced: 2024-08-03T22:26:16.432Z (3 months ago)
• Topics: croppie, image-cropper, obsidian, obsidian-md, obsidian-plugin
• Language: JavaScript
• Homepage:
• Size: 1.04 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - gapmiss/croppie-for-obsidian - Image cropping plugin for Obsidian.md (JavaScript)

README

        
# Croppie 

## 🚧 W.I.P. pre-release BETA 🚧

[Croppie](https://github.com/Foliotek/Croppie) image cropper plugin for [Obsidian.md](https://obsidian.md)

## Screenshots

### Image cropping

![Image cropping](resources/CleanShot-Obsidian-Croppie-PLUGIN-Obsidian-v1.4.2-20230808072651.png)

### Gallery

![Gallery](resources/CleanShot-Obsidian-Croppie-PLUGIN-Obsidian-v1.4.2-20230808072636.png)

### Settings

![Plugin settings](resources/CleanShot-Obsidian-Croppie-PLUGIN-Obsidian-v1.4.2-20230808072712.png)

## Commands

1. `Croppie: Crop an image`

## Ribbon actions

1. `Crop an image`

2. `Croppie image gallery`

## File menu actions

1. `Croppie: OCR this image`

2. `Croppie: crop this image`

## Install

### via Release download

Download pre-release beta plugin from: [croppie-for-obsidian-v0.1.0-beta.zip](https://github.com/gapmiss/croppie-for-obsidian/releases/download/0.1.0-beta/croppie-for-obsidian-v0.1.0-beta.zip) or [gapmiss/croppie-for-obsidian/releases](https://github.com/gapmiss/croppie-for-obsidian/releases)

Once downloaded to one's local machine, follow these steps to install:

1. extract the downloaded archive (`croppie-for-obsidian-v0.1.0-beta.zip`)

2. move the extracted folder/directory to `/path/to/vault/.obsidian/plugins`

3. In **Obsidian settings** > **Community plugins**, enable the **Croppie** plugin

### via BRAT (Beta Reviewer's Auto-update Tool)

1. Ensure [BRAT](https://github.com/TfTHacker/obsidian42-brat) is installed

2. Trigger the command `Obsidian42 - BRAT: Add a beta plugin for testing` 

3. Enter this repository, `gapmiss/croppie-for-obsidian`

4. Enable *Croppie* plugin in community plugin list

## Issues and bug reports

Please submit issues, bug reports, feature requests, etc. to [gapmiss/croppie-for-obsidian/issues](https://github.com/gapmiss/croppie-for-obsidian/issues)

## Development

1. `cd /path/to/vault/.obsidian/plugins`

2. `git clone https://github.com/gapmiss/croppie-for-obsidian.git`

3. `cd croppie-for-obsidian`

4. `npm install`

5. `npm run dev`