Skip to content

Obsidian plugin for compressing images with TinyPNG

License

Notifications You must be signed in to change notification settings

ckt1031/obsidian-tinypng-plugin

Repository files navigation

Obsidian TingPNG Plugin

This streamlines Obsidian workflows by integrating TinyPNG's image compression service.

Note: This is NOT an official plugin from the TingPNG team. It is a community plugin.

Installation

You can install the Obsidian TingPNG Plugin by following these steps:

  1. Download 3 files: main.js, manifest.json, styles.css from the latest release.
  2. Create a folder named "obsidian-tinypng-plugin" in your Obsidian vault's plugins folder.
  3. Once the plugin is installed, activate it by toggling the switch next to its name.

Configuration

To configure the TingPNG plugin, you need to provide your API key and set the concurrency options. Here's how you can do it:

  1. Open the settings in Obsidian.
  2. Go to the "Plugins" section and find the TingPNG plugin.
  3. Enter your API key from Tinify in the corresponding field.
  4. Choose the desired concurrency level from the options provided.
  5. Click the "Save" button to save your settings.

Usage

To compress images using the TingPNG plugin, follow these steps:

  1. Open Obsidian and navigate to the vault where your images are located.
  2. Press Ctrl/Cmd + P to open the command palette.
  3. Search for "Compress Images" and select it from the list.
  4. The plugin will start compressing the images using the provided API key and concurrency options.
  5. Once the compression is complete, you will see a notification with the results.

Note: Make sure to review the TingPNG terms of service and API usage limits before using the plugin.

Feedback and Support

If you encounter any issues with the TingPNG plugin or have suggestions for improvements, please reach out to the community for support.

Disclaimer: This plugin is not affiliated with or endorsed by the TingPNG team. Use at your own risk.